Mybatis数据库字段加解密1-使用mysql自带加密方法

系列文章

1. Mybatis数据库字段加解密1-使用mysql自带加密方法
2. Mybatis数据库字段加解密2-使用typeAlias实现

简介

本文以用户表为例，介绍如何在Mybatis的mapper.xml中对MySql数据库表的字段进行加解密。主要包括设置和获取全局变量和加密方法使用。

定义SqlSession全局变量

// import org.apache.ibatis.session.Configuration
final String key = "AES_KEY"； // sqlSession中全局属性kv中的key
String aesKey = "aesKey"; // aes加密使用的key
Configuration configuration = new Configuration(environment);
configuration.setMapUnderscoreToCamelCase(true); //数据库中下划线方式的键将映射到java pojo中的驼峰命名法的属性。如user_id映射为userId。
// 将全局变量存入sqlSession
configuration.getVariables().put(key, aesKey);
...
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

获取全局变量

• java方式

sqlSessionFactory.getConfiguration().getVariables().get(key)

• 动态SQL方式

'${AES_KEY}'

UserMapper.xml加解密username等字段

• 加密过程：先将字段转化为16进制格式的字符串表示，再进行AES加密。
• 解密过程：先将字段使用加密时的key进行解密，再将中间值从16进制字符串还原为原来的值。

<sql id="decryptGetColumns">
         user_id, password,
         AES_DECRYPT(unhex(username), '${AES_KEY}') username,
         AES_DECRYPT(unhex(nickname), '${AES_KEY}') nickname,
         AES_DECRYPT(unhex(phone), '${AES_KEY}') phone,
         AES_DECRYPT(unhex(email), '${AES_KEY}') email,
         register_time, source, local_lang, account_status, country, province, city, sex, age
</sql>
 <!-- 添加用户，加密字段-->
 <insert id="addUser" parameterType="com.scut.emos.entity.User">
      INSERT INTO user_t(user_id, username, password, nickname, phone, email, register_time, source, local_lang,
    account_status, country, province, city, sex, age)
      VALUES (#{userId},
        hex(AES_ENCRYPT(#{username}, '${AES_KEY}')),
        #{password},
        hex(AES_ENCRYPT(#{nickname}, '${AES_KEY}')),
        hex(AES_ENCRYPT(#{phone},  '${AES_KEY}')),
        hex(AES_ENCRYPT(#{email}, '${AES_KEY}')),
        #{registerTime}, #{source}, #{localLang}, #{accountStatus}, #{country}, #{province}, #{city}, #{sex}, #{age});
</insert>
 <!-- 查询用户，解密字段-->
<select id="getUserByUserId" parameterType="Long" resultType="com.scut.emos.entity.User">
        SELECT
        <include refid="decryptGetColumns"/>
        FROM user_t
        WHERE user_id = #{userId}
        LIMIT 1
</select>
 <select id="getUserByUsername" parameterType="String" resultType="com.scut.emos.entity.User">
        SELECT
        <include refid="decryptGetColumns"/>
        FROM user_t
        WHERE username = hex(AES_ENCRYPT(#{username}, '${AES_KEY}'))
        LIMIT 1;
 </select>

参考文献

• Mybatis帮助文档

本文作者： seawish
版权声明： 本博客所有文章除特别声明外，均采用 CC BY-NC-SA 3.0 许可协议。转载请注明出处！