8Sharding-JDBC 数据脱敏 · SpringCloud微服务实战

导航

本节代码地址

GitHub:https://github.com/xuyisu/fw-shardingsphere-learning/tree/master/shardingsphere-learning-encryptor

本节主要介绍Sharding-JDBC数据脱敏，并提供代码样例，再项目中也是一种方案。

项目技术栈

技术栈	版本
jdk	1.8.0_161
SpringBoot	2.2.2.RELEASE
Shardingsphere	4.0.1
Mybatis-plus	3.3.0
Hutool	5.0.6
HikariCP	2.7.9

SpringBoot 基于SpringBoot 2.2.2.RELEASE 构建我们的应用
Shardingsphere 使用最新版的4.0.1来支撑读写分离
Mybatis-plus来作为我们的持久层框架，介绍代码的开发量
Hutool作为java工具包
HikariCP 项目中的连接池，性能要比Druid要高，目前SpringBoot 默认支持的数据连接池。
lombok 使代码简介，介绍getter\setter\构造器的创建，需要在idea中安装lombok插件

1. 数据库创建

1.1 新建数据库

mysql 数据库的搭建可以参考容器化章节（docker run 一个）

1.2 执行脚本

执行以下脚本将创建数据库ds_master，并在库里面创建sys_user表

CREATE DATABASE ds_master;
USE ds_master;
DROP TABLE IF EXISTS `sys_user`;
CREATE TABLE `sys_user` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键',
  `create_time` datetime(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3) COMMENT '创建时间',
  `update_time` datetime(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3) ON UPDATE CURRENT_TIMESTAMP(3) COMMENT '更新时间',
  `create_user` varchar(100) NOT NULL COMMENT '创建人编码',
  `update_user` varchar(100) NOT NULL COMMENT '修改人编码',
  `delete_flag` tinyint(4) NOT NULL DEFAULT '0' COMMENT '删除标记(1 删除 0未删除)',
  `pos_code` varchar(50) DEFAULT NULL COMMENT '职位编码',
  `disable_flag` tinyint(4) NOT NULL DEFAULT '0' COMMENT '启用标记(1 禁用 0启用)',
  `avatar` varchar(100) DEFAULT NULL COMMENT '头像地址',
  `email` varchar(50) DEFAULT NULL COMMENT '邮箱',
  `password` varchar(100) DEFAULT NULL COMMENT '密码',
  `user_name` varchar(50) DEFAULT NULL COMMENT '用户名',
  `real_name` varchar(50) DEFAULT NULL COMMENT '真实姓名',
  `dept_code` varchar(50) DEFAULT NULL COMMENT '部门编码',
  `user_phone` varchar(15) DEFAULT NULL COMMENT '手机号',
  PRIMARY KEY (`id`) USING BTREE,
  UNIQUE KEY `idx_email` (`email`) USING BTREE COMMENT '邮箱索引',
  UNIQUE KEY `idx_user_name` (`user_name`) USING BTREE COMMENT '用户名索引',
  KEY `idx_dept_code` (`dept_code`) USING BTREE COMMENT '部门编码索引',
  KEY `idx_position_code` (`pos_code`) USING BTREE COMMENT '职位编码索引'
) ENGINE=InnoDB  DEFAULT CHARSET=utf8 COMMENT='系统用户表';

2. 新建读写分离模块shardingsphere-learning-encryptor

上面我们已经配置了公共的针对用户表的基本操作，这些暂时已经够我们演示用了，如果不够，可以自定义自己的实现

2.1 添加依赖

这里我们将shardingsphere-learning-common的包依赖进来，方便我们操作用户表的增删改查

<dependencies>
    <dependency>
        <groupId>com.yisu.fwcloud</groupId>
        <artifactId>shardingsphere-learning-common</artifactId>
        <version>${version}</version>
    </dependency>
</dependencies>

2.2 应用配置

这里笔者将默认的端口修改为了8900，然后就是配置Sharding-JDBC的数据源，我们本节演示的Sharding-JDBC读写分离需要两个库（真实项目中需要两个数据库实例）。

笔者在配置中先设置数据源的名称
配置数据库连接信息，如spring.shardingsphere.datasource.{数据源名称}.type
加解密器类型（AES）
配置存储明文的字段、存储密文的字段（可以使相同的字段，也可以是不同的字段）
将sql日志信息打印出来

server.port=8900

#数据源配置
spring.shardingsphere.datasource.names=ds
spring.shardingsphere.datasource.ds.type=com.zaxxer.hikari.HikariDataSource
spring.shardingsphere.datasource.ds.driver-class-name=com.mysql.cj.jdbc.Driver
spring.shardingsphere.datasource.ds.jdbc-jdbc-url=jdbc:mysql://${dbIp}:3306/ds_master?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
spring.shardingsphere.datasource.ds.username=root
spring.shardingsphere.datasource.ds.password=123456



##脱敏规则部分
#加解密器类型，可自定义或选择内置类型：MD5/AES
spring.shardingsphere.encrypt.encryptors.encryptor_aes.type=aes
#属性配置, 注意：使用AES加密器，需要配置AES加密器的KEY属性：aes.key.value
spring.shardingsphere.encrypt.encryptors.encryptor_aes.props.aes.key.value=123456
#存储明文的字段
spring.shardingsphere.encrypt.tables.sys_user.columns.user_name.plainColumn=user_name
#存储密文的字段
spring.shardingsphere.encrypt.tables.sys_user.columns.user_name.cipherColumn=user_name_cipher
#加密器名字
spring.shardingsphere.encrypt.tables.sys_user.columns.user_name.encryptor=encryptor_aes
#使用密文查询
spring.shardingsphere.props.query.with.cipher.comlum=true
#开启SQL显示，默认值: false
spring.shardingsphere.props.sql.show=true

spring.main.allow-bean-definition-overriding=true

2.3 新建启动类


@SpringBootApplication
public class FwShardingsphereEncryptor{

    public static void main(String[] args) {
        SpringApplication.run(FwShardingsphereEncryptor.class, args);
    }

}

2.4 新建单元测试

新建单元测试，用于测试同库分表的功能

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class UserinfoServiceImplEncryptorTest{

    @Autowired
    private SysUserService sysUserService;

    
    @Test
    public void testSelect(){
        int count = sysUserService.count();
        System.out.println(count);
    }

    
    @Test
    public void testInsert(){
        SysUser sysUser=new SysUser();
        sysUser.setAvatar("/home/avatar");
        sysUser.setCreateTime(DateUtil.date());
        sysUser.setCreateUser("sys");
        sysUser.setDeleteFlag(0);
        sysUser.setDeptCode("depe");
        sysUser.setDisableFlag(0);
        sysUser.setEmail("***@123.com");
        sysUser.setPassword("123456");
        sysUser.setPosCode("pos");
        sysUser.setRealName("realname");
        sysUser.setUpdateTime(DateUtil.date());
        sysUser.setUserName("fwcloud");
        sysUser.setUpdateUser("sys");
        sysUser.setUserPhone("12345678912");
        sysUserService.save(sysUser);
    }

    
    @Test
    public void testBatch(){
        List<SysUser> list=new ArrayList<>();
        for (int i = 0; i <100 ; i++) {
            SysUser sysUser=new SysUser();
            sysUser.setAvatar("/home/avatar");
            sysUser.setCreateTime(DateUtil.date());
            sysUser.setCreateUser("sys"+i);
            sysUser.setDeleteFlag(0);
            sysUser.setDeptCode("depe"+i);
            sysUser.setDisableFlag(0);
            sysUser.setEmail("***@123.com"+i);
            sysUser.setPassword("123456");
            sysUser.setPosCode("pos");
            sysUser.setRealName("realname"+i);
            sysUser.setUpdateTime(DateUtil.date());
            sysUser.setUserName("fwcloud"+i);
            sysUser.setUpdateUser("sys"+i);
            sysUser.setUserPhone("12345678912"+i);
            list.add(sysUser);
        }

        boolean saveBatch = sysUserService.saveBatch(list);
        Assert.assertEquals(true,saveBatch);
    }

}

2.4.1 测试新增

先配置数据库的ip地址，变量是dbIp，值是ip地址，也可以不用变量直接用真实的ip地址

运行testBatch方法，可以看到已经脱敏后的数据

至此，数据脱敏已完成

8Sharding-JDBC 数据脱敏 · SpringCloud微服务实战 · 看云