系列文章
簡(jiǎn)介
本文以用戶表為例懈贺，介紹如何使用Mybatis的TypeAlias和TypeHandler厅缺，對(duì)MySql數(shù)據(jù)庫表的字段進(jìn)行加解密棒妨。
實(shí)現(xiàn)原理
- 本文使用MyBatis TypeHandler 可以在 JavaType 和 JdbcType 中互相轉(zhuǎn)換的特性，攔截 JavaType 為 AESEncrypt 的SQL祖灰，在預(yù)處理語句（PreparedStatement）中設(shè)置參數(shù)時(shí)自動(dòng)加密，并在結(jié)果集（ResultSet）中取值時(shí)自動(dòng)解密畔规。
- 提供加解密方法局扶，方法兼容mysql自帶 的AES_ENCRYPT和AES_DECRYPT方法，所以可以直接使用mysql命令進(jìn)行驗(yàn)證。
加密方式： hex(AES_ENCRYPT(#{username}, '${AES_KEY}'))
解密方式： AES_DECRYPT(unhex(username), '${AES_KEY}')
- 提供注冊(cè)javaType和typeHandler的方法三妈，以便動(dòng)態(tài)增加typeAlias畜埋。主要是通過讀取aliases包和handlers包路徑下的類文件，進(jìn)行注冊(cè)畴蒲。
實(shí)現(xiàn)過程
加載typeAlias和typeHandle類
photo1.png
- 創(chuàng)建typeAliases和typeHandles兩個(gè)package
- 創(chuàng)建AESEncrypt.java
該類定義一個(gè)名為AESEncrypt的javaType悠鞍，用于和jdbcType進(jìn)行相互映射。
import org.apache.ibatis.type.Alias;
@Alias("AESEncrypt")
public class AESEncrypt {
}
- 創(chuàng)建AESTypeHandler.java
該類用于處理javaType為AESEncrypt的數(shù)據(jù)庫字段模燥，對(duì)插入操作的相關(guān)字段進(jìn)行加密咖祭，對(duì)檢索操作的結(jié)果進(jìn)行解密。
@MappedTypes(AESEncrypt.class)
public class EncryptTypeHandler extends BaseTypeHandler<String> {
private static final Logger LOG = LoggerFactory.getLogger(EncryptTypeHandler.class);
private static final String aesKey = "emosskgkey";
/**
* 用于定義在Mybatis設(shè)置參數(shù)時(shí)該如何把Java類型的參數(shù)轉(zhuǎn)換為對(duì)應(yīng)的數(shù)據(jù)庫類型
*
* @param ps 當(dāng)前的PreparedStatement對(duì)象
* @param i 當(dāng)前參數(shù)的位置
* @param parameter 當(dāng)前參數(shù)的Java對(duì)象
* @param jdbcType 當(dāng)前參數(shù)的數(shù)據(jù)庫類型
* @throws SQLException
*/
@Override
public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType)
throws SQLException {
// 只要 parameter 非空都進(jìn)行加密
LOG.info("setNonNullParameter index <{}>, param <{}> ", i, parameter);
ps.setString(i, EndecryptUtil.AESEncrypt(parameter, aesKey));
}
/**
* 用于在Mybatis獲取數(shù)據(jù)結(jié)果集時(shí)如何把數(shù)據(jù)庫類型轉(zhuǎn)換為對(duì)應(yīng)的Java類型
*
* @param rs 當(dāng)前的結(jié)果集
* @param columnName 當(dāng)前的字段名稱
* @return 轉(zhuǎn)換后的Java對(duì)象
* @throws SQLException
*/
@Override
public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
String r = rs.getString(columnName);
return r == null ? null : EndecryptUtil.AESDecrypt(r, aesKey);
}
/**
* 用于在Mybatis通過字段位置獲取字段數(shù)據(jù)時(shí)把數(shù)據(jù)庫類型轉(zhuǎn)換為對(duì)應(yīng)的Java類型
*
* @param rs 當(dāng)前的結(jié)果集
* @param columnIndex 當(dāng)前字段的位置
* @return 轉(zhuǎn)換后的Java對(duì)象
* @throws SQLException
*/
@Override
public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
String r = rs.getString(columnIndex);
return r == null ? null : EndecryptUtil.AESDecrypt(r, aesKey);
}
/**
* 用于Mybatis在調(diào)用存儲(chǔ)過程后把數(shù)據(jù)庫類型的數(shù)據(jù)轉(zhuǎn)換為對(duì)應(yīng)的Java類型
*
* @param cs 當(dāng)前的CallableStatement執(zhí)行后的CallableStatement
* @param columnIndex 當(dāng)前輸出參數(shù)的位置
* @return
* @throws SQLException
*/
@Override
public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
String r = cs.getString(columnIndex);
// 兼容待修復(fù)的數(shù)據(jù)
return r == null ? null : EndecryptUtil.AESDecrypt(r, aesKey);
}
}
- 在SqlSession中注冊(cè)typeAliases
- 配置SqlSession：
TYPE_ALIAS_PACKAGE_PATH為Alias類存放目錄路徑蔫骂，如com.xxx.mybatis.typeAliases
TYPE_HANDLE_PACKAGE_PATH為Handler類存放的目錄路徑么翰，如com.xxx.mybatis.typeHandles
PooledDataSource dataSource = new PooledDataSource();
......
Environment environment = new Environment("development", transactionFactory, dataSource);
// 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); //數(shù)據(jù)庫中下劃線方式的鍵將映射到j(luò)ava pojo中的駝峰命名法的屬性辽旋。如user_id映射為userId浩嫌。
// 注冊(cè)typeAliases
registryTypeAlias(configuration, TYPE_ALIAS_PACKAGE_PATH, TYPE_HANDLE_PACKAGE_PATH);
......
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);
- registryTypeAlias方法:
/**
* 注冊(cè)mybatis的自定義javaType和相應(yīng)的typeHandler
* 當(dāng)aliasPackage和handlePackage為null，直接return补胚。
* @param configuration
*/
private void registryTypeAlias(Configuration configuration, String aliasPackage, String handlePackage) {
if(aliasPackage == null || handlePackage == null)
return;
TypeAliasRegistry typeAliasRegistry = configuration.getTypeAliasRegistry();
typeAliasRegistry.registerAliases(aliasPackage);
TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
// typeHandlerRegistry.register(AESEncrypt.class, EncryptTypeHandler.class);
typeHandlerRegistry.register(handlePackage);
}
- 字段加解密方法
采用AES進(jìn)行加解密码耐。
/**
* 使用aes加密
* 功能和mysql的hex(AES_ENCRYPT(content,'key'))一樣，使用utf-8編碼
*
* @param content
* @param key
* @return
*/
public static String AESEncrypt(String content, String key) {
try {
final Cipher encryptCipher = Cipher.getInstance("AES");
SecretKeySpec secretKeySpec = generateMySQLAESKey(key, defaultCharset);
encryptCipher.init(Cipher.ENCRYPT_MODE, secretKeySpec);
byte valBytes[] = encryptCipher.doFinal(content.getBytes(defaultCharset));
return new String(Hex.encodeHex(valBytes));
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
/**
* 使用aes解密溶其，
* 功能和mysql的AES_DECRYPT(unhex(content),'key')一樣骚腥，使用utf-8編碼
*
* @param content
* @param key
* @return
*/
public static String AESDecrypt(String content, String key) {
try {
final Cipher decryptCipher = Cipher.getInstance("AES");
SecretKeySpec secretKeySpec = generateMySQLAESKey(key, defaultCharset);
decryptCipher.init(Cipher.DECRYPT_MODE, secretKeySpec);
byte valBytes[] = decryptCipher.doFinal(Hex.decodeHex(content.toCharArray()));
return new String(valBytes);
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
/**
* 使用aes加密，使用默認(rèn)key
* 功能和mysql的hex(AES_ENCRYPT(content,'key'))一樣握联，使用utf-8編碼
*
* @param content
* @return
*/
public static String AESEncrypt(String content) {
return AESEncrypt(content, KEY);
}
/**
* 使用aes解密桦沉，使用默認(rèn)key。
* 功能和mysql的AES_DECRYPT(unhex(content),'key')一樣金闽，使用utf-8編碼
*
* @param content
* @return
* @throws Exception
*/
public static String AESDecrypt(String content) {
return AESDecrypt(content, KEY);
}
/**
* @param key
* @param encoding
* @return
*/
public static SecretKeySpec generateMySQLAESKey(final String key, final String encoding) {
try {
final byte[] finalKey = new byte[16];
int i = 0;
for (byte b : key.getBytes(encoding))
finalKey[i++ % 16] ^= b;
return new SecretKeySpec(finalKey, "AES");
} catch (UnsupportedEncodingException e) {
throw new RuntimeException(e);
}
}
Mapper.xml使用自定義的javaType
<!-- select： 在 resultMap 或 SQL 中需要加密的字段上聲明 `javaType="AESEncrypt"` -->
<resultMap id="BaseResultMap" type="user">
<id column="id" property="id" jdbcType="BIGINT" />
<result column="username" javaType="string" jdbcType="VARCHAR" property="username" />
<result column="password" javaType="AESEncrypt" jdbcType="VARCHAR" property="password" />
</resultMap>
<!-- insert： 在 SQL 中需要加密的字段上聲明 `javaType="AESEncrypt"` -->
<insert id="insert" parameterType="user">
insert into user_t (id, username, password)
values (#{id,jdbcType=BIGINT}, #{username,jdbcType=VARCHAR}, #{password, javaType=AESEncrypt, jdbcType=VARCHAR})
</insert>
<!-- update： 在 SQL 中需要加密的字段上聲明 `javaType="AESEncrypt"` -->
<update id="update" parameterType="user">
update user_t set password=#{password, javaType=AESEncrypt, jdbcType=VARCHAR} where id=#{id}
</update>
<!-- 檢索用戶列表, 通過BaseResultMap進(jìn)行加解密-->
<select id="getUserList" parameterType="map" resultMap="BaseResultMap">
select * from user_t
</select>
參考文獻(xiàn)
- MyBatis Type Handlers for Encrypt
- mybatis generator 自定義 TypeHandler 對(duì)數(shù)據(jù)庫敏感字段進(jìn)行加解密
- java語言實(shí)現(xiàn)mysql aes加解密方法
本文作者： seawish
版權(quán)聲明： 本博客所有文章除特別聲明外纯露，均采用 CC BY-NC-SA 3.0 許可協(xié)議。轉(zhuǎn)載請(qǐng)注明出處代芜！
