MyBatis利用攔截器實現(xiàn)數(shù)據(jù)脫敏詳解

更新時間：2023年11月01日 15:07:56 作者：小新成長之路

現(xiàn)代網(wǎng)絡(luò)環(huán)境中,敏感數(shù)據(jù)的處理是至關(guān)重要的,敏感數(shù)據(jù)包括個人身份信息、銀行賬號、手機號碼等,所以本文主要為大家詳細介紹了MyBatis如何利用攔截器實現(xiàn)數(shù)據(jù)脫敏,希望對大家有所幫助

背景

現(xiàn)代網(wǎng)絡(luò)環(huán)境中，敏感數(shù)據(jù)的處理是至關(guān)重要的。敏感數(shù)據(jù)包括個人身份信息、銀行賬號、手機號碼等，泄露這些數(shù)據(jù)可能導致用戶隱私泄露、財產(chǎn)損失等嚴重后果。因此，對敏感數(shù)據(jù)進行脫敏處理是一種必要的安全措施。

比如頁面上常見的敏感數(shù)據(jù)都是加*遮擋處理過的，如下圖所示。

接下來本文將以Spring Boot和MyBatis框架實現(xiàn)返回數(shù)據(jù)的脫敏處理。

脫敏工具

脫敏工具有很多種，本文主要介紹和使用hutool工具包提供的脫敏工具類DesensitizedUtil，它提供了常見的手機號、身份證號、銀行卡、郵箱等脫敏的方法，將敏感數(shù)據(jù)部分加*處理。
使用方法如下：
maven項目需要導入hutool包依賴，坐標如下：

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-core</artifactId>
    <version>5.8.4</version>
</dependency>

import cn.hutool.core.util.DesensitizedUtil;
 
public class SensitiveHutoolTest {
    public static void main(String[] args) {
        System.out.println(DesensitizedUtil.mobilePhone("13812345678"));
        System.out.println(DesensitizedUtil.idCardNum("110101200007283706", 3, 4));
        System.out.println(DesensitizedUtil.bankCard("6225809637392380845"));
        System.out.println(DesensitizedUtil.email("zhangsanfeng@test.com"));
    }
}

輸出如下：

138****5678
110***********3706
6225 **** **** *** 0845
z***********@test.com

實現(xiàn)思路

設(shè)計一個常用的脫敏類型枚舉類。
編寫脫敏注解，包含脫敏類型，采用注解的方式對需要脫敏的字段進行標注。
再編寫脫敏注解相應(yīng)的實現(xiàn)邏輯使用MyBatis的攔截器功能對查出的結(jié)果集采用反射的處理方式對結(jié)果進行脫敏處理，然后將脫敏處理后的結(jié)果集再返回。

代碼實現(xiàn)

定義脫敏類型枚舉

利用hutool工具包，對常見的手機號、身份證號、銀行卡號、郵箱進行脫敏處理。還給了一個默認的DEFAULT枚舉類型按原數(shù)據(jù)返回，同時自定義了一個CUSTOM枚舉，可根據(jù)實現(xiàn)CustomMaskService這個接口去自定義脫敏邏輯。

注意：這里的CUSTOM只是舉一個簡單的例子，實際情況可能需要根據(jù)實際情況擴展輸入輸出參數(shù)等。

import cn.hutool.core.util.DesensitizedUtil;
import lombok.Getter;
 
public enum SensitiveTypeEnum {
    MOBILE("mobile", "手機號") {
        @Override
        public String maskSensitiveData(String data) {
            //手機號前3位后4位脫敏，中間部分加*處理，比如：138****5678
            return DesensitizedUtil.mobilePhone(data);
        }
    },
    IDENTIFY("identify", "身份證號") {
        @Override
        public String maskSensitiveData(String data) {
            //身份證前3位后4位脫敏，中間部分加*處理，比如：110***********3706
            return DesensitizedUtil.idCardNum(data, 3, 4);
        }
    },
    BANKCARD("bankcard", "銀行卡號") {
        @Override
        public String maskSensitiveData(String data) {
            //銀行卡號前4位后4位脫敏，中間部分加*處理，比如：6225 **** **** *** 0845
            return DesensitizedUtil.bankCard(data);
        }
    },
 
    EMAIL("email", "郵箱") {
        @Override
        public String maskSensitiveData(String data) {
            //郵箱@符號后明文顯示，@符號前的字符串，只顯示第一個字符，其余加*處理，比如：z***********@test.com
            return DesensitizedUtil.email(data);
        }
    },
    DEFAULT("default", "默認") {
        @Override
        public String maskSensitiveData(String data) {
            // 默認原值返回，其他這個也沒啥意義^_^
            return data;
        }
    },
    CUSTOM("custom", "自定義") {
        @Override
        public String maskSensitiveData(String data, CustomMaskService customMaskService) {
            // 可以自定義處理的service，根據(jù)實際使用情況可能需要添加參數(shù)，調(diào)整一下即可
            return customMaskService.maskData(data);
        }
    };
 
 
    @Getter
    private String type;
 
    @Getter
    private String desc;
 
    SensitiveTypeEnum(String type, String desc) {
        this.type = type;
        this.desc = desc;
    }
 
    /**
     * 遮擋敏感數(shù)據(jù)
     *
     * @param data
     * @return
     */
    public String maskSensitiveData(String data) {
        return data;
    }
 
    public String maskSensitiveData(String data, CustomMaskService customMaskService) {
        return null;
    }
}

定義一個脫敏注解

import java.lang.annotation.*;
 
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface SensitiveData {
    SensitiveTypeEnum type() default SensitiveTypeEnum.DEFAULT;
}

定義并配置一個mybatis攔截器。

import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.executor.resultset.ResultSetHandler;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Signature;
import org.springframework.beans.factory.annotation.Autowired;
 
import java.lang.reflect.Field;
import java.sql.Statement;
import java.util.List;
import java.util.Map;
 
@Intercepts({
        @Signature(type = ResultSetHandler.class, method = "handleResultSets", args = {Statement.class})
})
@Slf4j
public class SensitiveDataInterceptor implements Interceptor {
 
    @Autowired
    private CustomMaskService customMaskService;
 
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Object result = invocation.proceed();
        log.debug("進入數(shù)據(jù)脫敏攔截器...");
        if (result instanceof List) {
            List<?> resultList = (List<?>) result;
            for (Object obj : resultList) {
                doSensitiveFields(obj);
            }
        } else if (result instanceof Map) {
            Map<?, ?> resultMap = (Map<?, ?>) result;
            for (Object obj : resultMap.values()) {
                doSensitiveFields(obj);
            }
        } else {
            doSensitiveFields(result);
        }
        return result;
    }
 
    private void doSensitiveFields(Object obj) throws IllegalAccessException {
        Field[] fields = obj.getClass().getDeclaredFields();
        for (Field field : fields) {
            if (field.isAnnotationPresent(SensitiveData.class)) {
                field.setAccessible(true);
                Object value = field.get(obj);
                if (value == null) {
                    return;
                }
                SensitiveData sensitiveData = field.getAnnotation(SensitiveData.class);
                SensitiveTypeEnum type = sensitiveData.type();
                String result;
                if (type == SensitiveTypeEnum.CUSTOM) {
                    result = type.maskSensitiveData(value.toString(), customMaskService);
                } else {
                    result = type.maskSensitiveData(value.toString());
                }
                field.set(obj, result);
            }
        }
    }
}

攔截器注解里寫明了要攔截的對象和方法，類：ResultSetHandler，方法：handleResultSets，它是在sql執(zhí)行完成后拿到結(jié)果集并對結(jié)果集進行處理再返回。

配置mybatis及攔截器

import com.star95.project.study.mybatisplus.interceptor.SensitiveDataInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
@Configuration
@MapperScan("com.star95.project.study.mybatisplus.mapper")
public class MyBatisPlusConfig {
 
    @Bean
    public SensitiveDataInterceptor sensitiveDataInterceptor() {
        return new SensitiveDataInterceptor();
    }
}

測試

import com.star95.project.study.mybatisplus.interceptor.SensitiveData;
import lombok.Data;
 
import static com.star95.project.study.mybatisplus.interceptor.SensitiveTypeEnum.*;
 
@Data
public class UserDto {
    /**
     * id
     */
    private Long id;
    /**
     * 姓名
     */
    @SensitiveData(type = CUSTOM)
    private String name;
    /**
     * 年齡
     */
    private Integer age;
 
    /**
     * 郵箱
     */
    @SensitiveData(type = EMAIL)
    private String email;
 
    /**
     * 手機號
     */
    @SensitiveData(type = MOBILE)
    private String mobile;
 
    /**
     * 身份證號
     */
    @SensitiveData(type = IDENTIFY)
    private String identify;
 
    /**
     * 銀行卡號
     */
    @SensitiveData(type = BANKCARD)
    private String bankcard;
}

public interface CustomMaskService {
    String maskData(String data);
}

import cn.hutool.core.text.CharSequenceUtil;
import org.springframework.stereotype.Service;
 
@Service
public class CustomMaskServiceImpl implements CustomMaskService {
    @Override
    public String maskData(String data) {
        //第一個字符明文外，其他都加*處理
        return CharSequenceUtil.hide(data, 1, data.length());
    }
}

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.star95.project.study.mybatisplus.dto.User;
import com.star95.project.study.mybatisplus.dto.UserDto;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
 
import java.util.List;
 
@Mapper
public interface UserMapper extends BaseMapper<User> {
    @Select({"select * from user where id=#{id}"})
    UserDto getSpecialUser(String id);
 
    @Select({"select * from user"})
    List<UserDto> queryAll();
}

import com.star95.project.study.mybatisplus.dto.UserDto;
import com.star95.project.study.mybatisplus.mapper.UserMapper;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
import javax.annotation.Resource;
import java.util.List;
 
@RestController
@RequestMapping("/sensitive")
public class SensitiveMybatisInterceptorTestController {
    @Resource
    private UserMapper userMapper;
 
    @GetMapping("/user/{id}")
    public Result<UserDto> queryUserInfo(@PathVariable String id) {
        return Result.success(userMapper.getSpecialUser(id));
    }
 
    @GetMapping("/userlist")
    public Result<List<UserDto>> queryUserList() {
        return Result.success(userMapper.queryAll());
    }
}

寫了兩個測試接口，一個是查詢單個對象，一個是返回list集合列表，訪問一下：

可以看到單個結(jié)果和集合列表都做了脫敏處理，這樣功能就實現(xiàn)完成了。

其他

使用mybatis攔截器這種方式，是在數(shù)據(jù)持久層的邏輯處理，需要注意的是，查詢結(jié)果返回的dto如果是共享的情況下，可能會把不需要脫敏的數(shù)據(jù)也給處理了，影響業(yè)務(wù)邏輯，所以使用過程中要注意區(qū)分。

另外也可在接口返回數(shù)據(jù)時進行脫敏處理，也就是所說的序列化方式，比如自定義Jackson、fastjson等的序列化邏輯同樣可以完成數(shù)據(jù)脫敏。

總結(jié)

通過使用MyBatis攔截器，我們可以實現(xiàn)對敏感數(shù)據(jù)的優(yōu)雅脫敏處理，保護用戶隱私和數(shù)據(jù)安全。這種方式可以靈活應(yīng)用于各種場景，提供了一種簡單而強大的解決方案。在實際開發(fā)中，我們可以根據(jù)具體需求，定制化開發(fā)攔截器的邏輯，以滿足不同的數(shù)據(jù)脫敏需求。

數(shù)據(jù)的隱私和安全是非常重要的，敏感數(shù)據(jù)除存儲方面要加密外，再展示方便也要適當?shù)淖雒撁籼幚?，本文只介紹了mybatis攔截器實現(xiàn)的一種數(shù)據(jù)脫敏方式，還有很多其他技術(shù)可以實現(xiàn)，可以自行搜索，根據(jù)實際情況選擇合適的解決方案。

以上就是MyBatis利用攔截器實現(xiàn)數(shù)據(jù)脫敏詳解的詳細內(nèi)容，更多關(guān)于MyBatis數(shù)據(jù)脫敏的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: