MyBatis攔截器優雅實現數據脫敏

来源:https://www.cnblogs.com/star95/archive/2023/11/01/17803130.html
-Advertisement-
Play Games

背景 現代網路環境中，敏感數據的處理是至關重要的。敏感數據包括個人身份信息、銀行賬號、手機號碼等，泄露這些數據可能導致用戶隱私泄露、財產損失等嚴重後果。因此，對敏感數據進行脫敏處理是一種必要的安全措施。 比如頁面上常見的敏感數據都是加*遮擋處理過的，如下圖所示。 接下來本文將以Spring Boot ...


背景

現代網路環境中，敏感數據的處理是至關重要的。敏感數據包括個人身份信息、銀行賬號、手機號碼等，泄露這些數據可能導致用戶隱私泄露、財產損失等嚴重後果。因此，對敏感數據進行脫敏處理是一種必要的安全措施。
比如頁面上常見的敏感數據都是加*遮擋處理過的，如下圖所示。

接下來本文將以Spring Boot和MyBatis框架實現返回數據的脫敏處理。

脫敏工具

脫敏工具有很多種，本文主要介紹和使用hutool工具包提供的脫敏工具類DesensitizedUtil，它提供了常見的手機號、身份證號、銀行卡、郵箱等脫敏的方法，將敏感數據部分加*處理。
使用方法如下：
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("[email protected]"));
    }
}

輸出如下：

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

實現思路

  • 設計一個常用的脫敏類型枚舉類。
  • 編寫脫敏註解，包含脫敏類型，採用註解的方式對需要脫敏的欄位進行標註。
  • 再編寫脫敏註解相應的實現邏輯使用MyBatis的攔截器功能對查出的結果集採用反射的處理方式對結果進行脫敏處理，然後將脫敏處理後的結果集再返回。

代碼實現

  1. 定義脫敏類型枚舉

利用hutool工具包，對常見的手機號、身份證號、銀行卡號、郵箱進行脫敏處理。還給了一個預設的DEFAULT枚舉類型按原數據返回，同時自定義了一個CUSTOM枚舉，可根據實現CustomMaskService這個介面去自定義脫敏邏輯。

註意：這裡的CUSTOM只是舉一個簡單的例子，實際情況可能需要根據實際情況擴展輸入輸出參數等。

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，根據實際使用情況可能需要添加參數，調整一下即可
            return customMaskService.maskData(data);
        }
    };


    @Getter
    private String type;

    @Getter
    private String desc;

    SensitiveTypeEnum(String type, String desc) {
        this.type = type;
        this.desc = desc;
    }

    /**
     * 遮擋敏感數據
     *
     * @param data
     * @return
     */
    public String maskSensitiveData(String data) {
        return data;
    }

    public String maskSensitiveData(String data, CustomMaskService customMaskService) {
        return null;
    }
}
  1. 定義一個脫敏註解
import java.lang.annotation.*;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface SensitiveData {
    SensitiveTypeEnum type() default SensitiveTypeEnum.DEFAULT;
}
  1. 定義並配置一個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("進入數據脫敏攔截器...");
        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執行完成後拿到結果集並對結果集進行處理再返回。

  1. 配置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();
    }
}
  1. 測試
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集合列表，訪問一下：

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

其他

使用mybatis攔截器這種方式，是在數據持久層的邏輯處理，需要註意的是，查詢結果返回的dto如果是共用的情況下，可能會把不需要脫敏的數據也給處理了，影響業務邏輯，所以使用過程中要註意區分。
另外也可在介面返回數據時進行脫敏處理，也就是所說的序列化方式，比如自定義Jackson、fastjson等的序列化邏輯同樣可以完成數據脫敏。

總結

通過使用MyBatis攔截器，我們可以實現對敏感數據的優雅脫敏處理，保護用戶隱私和數據安全。這種方式可以靈活應用於各種場景，提供了一種簡單而強大的解決方案。在實際開發中，我們可以根據具體需求，定製化開發攔截器的邏輯，以滿足不同的數據脫敏需求。
數據的隱私和安全是非常重要的，敏感數據除存儲方面要加密外，再展示方便也要適當的做脫敏處理，本文只介紹了mybatis攔截器實現的一種數據脫敏方式，還有很多其他技術可以實現，可以自行搜索，根據實際情況選擇合適的解決方案。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 用了這款插件，零代碼基礎也能寫代碼你信嗎？
    一、寫在前面 使用過chatGPT的同學，可能都會有過這樣的經歷？遇到代碼不會的問題，本能的就會去求助chatGPT，然後並根據chatGPT的回答去優化代碼。但是，沒了梯子的話，chatGPT是不是也幫不上忙了？還是只有我是這樣的情況￣□￣｜｜ 當然，這也讓我偶然發現這個插件，對於我這種代碼渣渣來 ...
  • 簡單而又快捷的遙感影像生產線
    寫來寫去，發現還是寫博客比較隨意，不用考慮那麼的邏輯和語法什麼的，比寫SCI要舒服多了。言歸正傳，這一次我主要做了一個遙感影像生產線，如何理解呢？ 它主要就是用來將原始的L1產品，自動處理融合影像，也就是常說的正射影像或者DOM影像，而且支持底圖配準與勻光勻色處理，使用非常方便，支持大批量數據全 自 ...
  • Python JSON 使用指南：解析和轉換數據
    JSON 是一種用於存儲和交換數據的語法。JSON 是文本，使用 JavaScript 對象表示法編寫。 Python 中的 JSON Python 有一個內置的 json 包，可用於處理 JSON 數據。 示例：導入 json 模塊： import json 解析 JSON - 從 JSON 轉換 ...
  • 10、SpringMVC之處理Ajax請求
    創建名為spring_mvc_ajax的新module，過程參考9.1節和9.5節 10.1、SpringMVC處理Ajax請求 10.1.1、頁面請求示例 <input type="button" value="測試SpringMVC處理Ajax請求" onclick="testAjax()"> ...
  • tomcat nio2源碼分析
    一、 前言 ​ 最近在看tomcat connector組件的相關源碼，對Nio2的非同步回調過程頗有興趣，平時讀源碼不讀，自己讀的時候很多流程都沒搞明白，去查網上相關解析講的給我感覺也不是特別清晰，於是就自己慢慢看源碼，以下是我自己的見解，因為開發經驗也不多，剛成為社畜不久，有些地方講錯如果有大佬看 ...
  • 笑話短視頻API介面，讓你笑翻天！
    在如今這個信息爆炸的時代，短視頻成為了一種非常受歡迎的娛樂方式。而在短視頻中，各種搞笑的內容更是大受歡迎。因此，開發一個能夠讓人們笑翻天的笑話短視頻介面就成為了一個非常有趣的項目。本文將介紹如何使用挖數據平臺的API來開發一個簡單的笑話短視頻介面，並提供代碼說明。 API介紹 挖數據平臺提供了一個非 ...
  • 雙層while嵌套迴圈導致 500internal server error
    中斷系統：是執行和管理中斷的邏輯結構 外部中斷：是眾多能產生中斷的外設之一 中斷：指的是中斷源（中斷通道），中斷產生CPU暫停正在執行程式，去執行中斷程式，然後返回。提高效率 F1系列的STM32有68個中斷源，不同系列需要看手冊 EXTI(外部中斷)、TIM、ADC、USART、SPI、I2C、R ...
  • QT中級（2）QTableView自定義委托（二）實現QProgressBar委托
    同系列文章 QT中級（1）QTableView自定義委托（一）實現QSpinBox、QDoubleSpinBox委托 QT中級（2）QTableView自定義委托（二）實現QProgressBar委托 QT中級（3）QTableView自定義委托（三）實現QCheckBox委托並且將QCheckBo ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類