{"id":18050180,"url":"https://github.com/drtrang/typehandlers-encrypt","last_synced_at":"2025-08-12T01:06:39.349Z","repository":{"id":87814257,"uuid":"89473593","full_name":"drtrang/typehandlers-encrypt","owner":"drtrang","description":"MyBatis Type Handlers for Encrypt","archived":false,"fork":false,"pushed_at":"2018-01-16T07:16:19.000Z","size":49,"stargazers_count":132,"open_issues_count":4,"forks_count":41,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-07-28T10:46:34.296Z","etag":null,"topics":["encrypt","mybatis","typehandler"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/drtrang.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-26T11:32:38.000Z","updated_at":"2025-07-09T09:49:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"3ba2c579-8b8d-499a-8bc2-ace644e73cbb","html_url":"https://github.com/drtrang/typehandlers-encrypt","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/drtrang/typehandlers-encrypt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drtrang%2Ftypehandlers-encrypt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drtrang%2Ftypehandlers-encrypt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drtrang%2Ftypehandlers-encrypt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drtrang%2Ftypehandlers-encrypt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/drtrang","download_url":"https://codeload.github.com/drtrang/typehandlers-encrypt/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drtrang%2Ftypehandlers-encrypt/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269982061,"owners_count":24507301,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["encrypt","mybatis","typehandler"],"created_at":"2024-10-30T21:10:51.433Z","updated_at":"2025-08-12T01:06:39.323Z","avatar_url":"https://github.com/drtrang.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MyBatis Type Handlers for Encrypt\n\n[![Build Status](https://www.travis-ci.org/drtrang/typehandlers-encrypt.svg?branch=master)](https://www.travis-ci.org/drtrang/typehandlers-encrypt)\n[![Coverage Status](https://coveralls.io/repos/github/drtrang/typehandlers-encrypt/badge.svg?branch=master)](https://coveralls.io/github/drtrang/typehandlers-encrypt?branch=master)\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.drtrang/typehandlers-encrypt/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.drtrang/typehandlers-encrypt)\n[![License](http://img.shields.io/badge/license-apache%202-brightgreen.svg)](https://github.com/drtrang/typehandlers-encrypt/blob/master/LICENSE)\n\n## 介绍\n应公司安全部门要求，需要对数据库中的敏感信息做加密处理。由于此次需求涉及的字段较多，手动加解密颇为不便且改动较大，一个更加简单、通用的解决方案势在必行。\n\n`typehandlers-encrypt` 项目在这种背景下诞生，用户使用时无需更改业务代码，仅需少量配置即可实现数据库指定字段的加解密操作，大大减小了对用户的影响。\n\n\n## 实现原理\n\n`typehandlers-encrypt` 基于 MyBatis 的 TypeHandler 开发，通过 TypeHandler 可以在 JavaType 和 JdbcType 中互相转换的特性，拦截 JavaType 为 `com.github.trang.typehandlers.alias.Encrypt` 的 SQL，在预处理语句（PreparedStatement）中设置参数时自动加密，并在结果集（ResultSet）中取值时自动解密。\n\n注：由于依赖 MyBatis，使用时需要将 `EncryptTypeHandler` 和 `Encrypt` 注册到 MyBatis，否则无法生效，注册方式见 **声明 EncryptTypeHandler**。\n\n\n## 应用\n### 依赖\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.drtrang\u003c/groupId\u003e\n    \u003cartifactId\u003etypehandlers-encrypt\u003c/artifactId\u003e\n    \u003cversion\u003e1.1.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### 声明 EncryptTypeHandler\n#### 1. 单独使用 MyBatis\n```xml\n\u003c!-- mybatis-config.xml --\u003e\n\u003ctypeAliases\u003e\n    \u003cpackage name=\"com.github.trang.typehandlers.alias\" /\u003e\n\u003c/typeAliases\u003e\n\n\u003ctypeHandlers\u003e\n    \u003cpackage name=\"com.github.trang.typehandlers.type\" /\u003e\n\u003c/typeHandlers\u003e\n```\n\n#### 2. 与 Spring 结合\n```java\n@Bean\npublic SqlSessionFactory sqlSessionFactory(Configuration config) {\n    SqlSessionFactoryBean factory = new SqlSessionFactoryBean();\n    factory.setTypeAliasesPackage(\"com.github.trang.typehandlers.alias\");\n    factory.setTypeHandlersPackage(\"com.github.trang.typehandlers.type\");\n    return factory.getObject();\n}\n```\n\n#### 3. 与 SpringBoot 结合\n```yaml\n##application.yml\nmybatis:\n    type-aliases-package: com.github.trang.typehandlers.alias\n    type-handlers-package: com.github.trang.typehandlers.type\n```\n\n注：以上配置方式**任选其一**即可，请根据实际情况选择。\n\n### 使用 EncryptTypeHandler\n```xml\n\u003c!-- select： 在 resultMap 或 SQL 中需要加密的字段上声明 `javaType=\"encrypt\"` --\u003e\n\u003cresultMap id=\"BaseResultMap\" type=\"user\"\u003e\n    \u003cid column=\"id\" property=\"id\" jdbcType=\"BIGINT\" /\u003e\n    \u003cresult column=\"username\" javaType=\"string\" jdbcType=\"VARCHAR\" property=\"username\" /\u003e\n    \u003cresult column=\"password\" javaType=\"encrypt\" jdbcType=\"VARCHAR\" property=\"password\" /\u003e\n\u003c/resultMap\u003e\n\n\u003c!-- insert： 在 SQL 中需要加密的字段上声明 `javaType=\"encrypt\"` --\u003e\n\u003cinsert id=\"insert\" parameterType=\"user\"\u003e\n    insert into user (id, username, password)\n    values (#{id,jdbcType=BIGINT}, #{username,jdbcType=VARCHAR}, #{password, javaType=encrypt, jdbcType=VARCHAR})\n\u003c/insert\u003e\n\n\u003c!-- update： 在 SQL 中需要加密的字段上声明 `javaType=\"encrypt\"` --\u003e\n\u003cupdate id=\"update\" parameterType=\"user\"\u003e\n    update user set password=#{password, javaType=encrypt, jdbcType=VARCHAR} where id=#{id}\n\u003c/update\u003e\n```\n\n\n## 进阶\n`typehandlers-encrypt` 内置了 AES 加密算法与默认的 16 位密钥，支持**开箱即用**，但用户也可以自定义加密算法和密钥，只需要在配置文件中声明对应的配置即可。需要注意，**两者同时配置时，要声明在同一文件里**。\n\n配置示例：\n```properties\nencrypt.private.key=xxx\nencrypt.class.name=com.github.trang.typehandlers.crypt.SimpleEncrypt\n```\n\n### 配置文件查找\n方式一：项目启动时，会在项目的 Classpath 中依次查找名称为 `encrypt`、`properties/config-common`、`properties/config`、`config`、`application` 的 Properties 文件，直到文件存在且文件中包含名称为 `encrypt.private.key` 的属性时停止。\n\n方式二：如果项目中不存在以上文件，且不想单独新增，也可以在项目启动时调用 `ConfigUtil.bundleNames(\"xxx\")` 来指定要读取的文件，这时只会从用户给定的文件中查找。\n\n**当没有查找到相应配置时，项目会使用内置的默认配置。**\n\n### 自定义密钥\n`typehandlers-encrypt` 支持自定义密钥，只需在配置文件中声明即可。\n```properties\nencrypt.private.key=xxx\n```\n\n### 自定义加密算法\n`typehandlers-encrypt` 默认的加密算法是 **AES 对称加密**，如果默认算法不满足实际需求，用户可以自己实现 `com.github.trang.typehandlers.crypt.Crypt` 接口，并在配置文件中声明实现类的全路径。\n```properties\nencrypt.class.name=com.github.trang.typehandlers.crypt.SimpleEncrypt\n```\n\n\n## 硬广\n目前项目已开源，并上传到 [Github](https://github.com/drtrang/typehandlers-encrypt)，大家感兴趣的话可以阅读源码。[Github](https://github.com/drtrang/typehandlers-encrypt) 中有配套的 Demo 演示 [`typehandlers-encrypt-demo`](https://github.com/drtrang/typehandlers-encrypt-demo)，其中包括 `typehandlers-encrypt` 完整的使用方式，可以作为参考。\n\n如果有问题，可以在 Github 上提 ISSUE，或者 QQ 交流，以下是联系方式：\u003cbr\u003e\n我的 Github 主页：https://github.com/drtrang\u003cbr\u003e\n该项目的 Github 地址：https://github.com/drtrang/typehandlers-encrypt\u003cbr\u003e\n配套 Demo 的 Github 地址：https://github.com/drtrang/typehandlers-encrypt-demo\u003cbr\u003e\nBeanCopier 工具：https://github.com/drtrang/Copiers\u003cbr\u003e\nQQ：349096849\n\n\n\u003e **注意：**\n\u003e 1. 目前 `EncryptTypeHandler` 只支持 JavaType 为 **String** 的情形，如有其它需求，请及时联系我。\n\u003e 2. 加密时字段只过滤 **null 值**，非 null 的字段不做任何处理直接加密。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrtrang%2Ftypehandlers-encrypt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdrtrang%2Ftypehandlers-encrypt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrtrang%2Ftypehandlers-encrypt/lists"}