mybatis-crypt-helper

一种 MyBatis 下简便的数据库字段加解密方案，利用 TypeHandler 实现。

这是一个可以使用的模板项目，实际使用中可以根据需求修改加解密逻辑。

环境要求

MyBatis 3.x
JDK 1.8 (可以修改加密方式降低版本要求)

使用方法

Maven

添加 Maven 依赖

<dependency>
    <groupId>com.huiyadan</groupId>
    <artifactId>mybatis-crypt-helper</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

Mybatis 配置

1. 单独使用 MyBatis

<!-- mybatis-config.xml -->
<typeAliases>
    <package name="com.huiyadan.crypt.mybatis.alias" />
</typeAliases>

<typeHandlers>
    <package name="com.huiyadan.crypt.mybatis.type" />
</typeHandlers>

2. 与 Spring 结合

@Bean
public SqlSessionFactory sqlSessionFactory(Configuration config) {
    SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
    factory.setTypeAliasesPackage("com.huiyadan.crypt.mybatis.alias");
    factory.setTypeHandlersPackage("com.huiyadan.crypt.mybatis.type");
    return factory.getObject();
}

3. 与 SpringBoot 结合

##application.yml
mybatis:
    type-aliases-package: com.huiyadan.crypt.mybatis.alias
    type-handlers-package: com.huiyadan.crypt.mybatis.type

注：以上配置方式任选其一即可，请根据实际情况选择。且当前的配置方法并不唯一，MyBatis 提供了很多配置方法，更多配置方法可以参考官方文档

修改 sqlmap 进行加密

写入时加密，查询时解密示例：

<!-- select： 在 resultMap 中需要解密的字段上声明 `javaType="crypt"` -->
<resultMap id="BaseResultMap" type="com.huiyadan.crypt.mybatis.User">
    <id column="id" property="id" jdbcType="BIGINT"/>
    <result column="name" javaType="string" jdbcType="VARCHAR" property="name"/>
    <result column="phone" javaType="crypt" jdbcType="VARCHAR" property="phone"/>
</resultMap>

<!-- insert： 在 SQL 中需要加密的字段上声明 `javaType=crypt` -->
<insert id="insert" parameterType="com.huiyadan.crypt.mybatis.User">
    insert into user (id, name, phone) values (#{id}, #{name}, #{phone, javaType=crypt})
</insert>

<!-- update： 在 SQL 中需要加密的字段上声明 `javaType=crypt` -->
<update id="update" parameterType="com.huiyadan.crypt.mybatis.User">
    update user set phone=#{phone, javaType=crypt} where id=#{id}
</update>

注：当前配置方式时比较简洁的方法，除了指定 javaType ，还可以通过指定 typeHandler 实现加解密。

ztrun/mybatis-crypt-helper