# A.CTable框架 **Repository Path**: simplive/mybatis-enhance ## Basic Information - **Project Name**: A.CTable框架 - **Description**: A.CTable是一个基于Spring和Mybatis的Maven项目,actable 支持springboot,增强了Mybatis的功能,通过配置model注解的方式来创建表,修改表结构,提供通用的单表CUDR工具,目前仅支持Mysql - **Primary Language**: Java - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: https://blog.csdn.net/sun5769675/article/details/74779640 - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 175 - **Created**: 2020-06-02 - **Last Updated**: 2020-12-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # mybatis-enhance-actable-1.1.0.RELEASE A.C.Table是对Mybatis做的增强功能,为了能够使习惯了hibernate框架的开发者能够快速的入手Mybatis, “A.C.Table” 本意是自动建表的意思,A.C.Table是一个基于Spring和Mybatis的Maven项目,增强了Mybatis的功能,过配置model注解的方式来创建表,修改表结构,并且实现了共通的CUDR功能提升开发效率,目前仅支持Mysql,后续会扩展针对其他数据库的支持。 A.C.Table是采用了Spring、Mybatis技术的Maven结构,详细介绍如下: **######### mybatis增加功能自动创建表——A.C.Table版本说明################** 1. 该版本修复了修改主键同时修改其类型引起的error(版本1.0.1) 2. 该版本修复了根据model创建时没有创建父类中的字段的问题(ps:目前只支持扫描一层继承)(版本1.0.1) 3. 该版本增加了对唯一约束的支持(版本1.0.1) 4. 从原有的框架中剥离出来,支持任意结构的spring+mybatis的框架使用(版本1.0.1) 5. 再次声明A.C.Table目前仅支持mysql数据库(版本1.0.1) 6. 修复了不同数据库中有相同表名时,启动报错的问题。(版本1.0.2) 7. 修复了model属性名与表字段名不一致时公共的查询方法查不出数据的问题。(版本1.0.2) 8. 增加了对公共的CUDR方法的优化,保存成功会返回id,query查询时可以设置参数进行分页查询(pageSize:int类型标识每页数量,currentPage:int类型标识当前第几页,start:int类型从第几条开始,orderField:string类型排序字段,sortStr:string类型排序方式(desc,asc))(版本1.0.3) 9. 增加了对Mysql的longtext和mediumtext两种字段类型的支持,公共的CUDR方法的优化,原query方法更正为search,现query方法支持动态sql查询,原orderField字段只支持单个字段的排序,现修改为orderBy字段,支持数据类型为LinkedHashMap,有序,key为字段名,value为排序方式(版本1.0.4) 10. 增加对mysql数据库(timestamp/time/date/float/bit)五种数据类型的支持(版本1.0.5) 11. 增加对springboot框架的支持(版本1.0.5) 12. 删除旧版本在@Colum中实现唯一约束的方式(版本1.0.6.RELEASE) 13. 增加了新的唯一约束实现方式@Unique,支持多字段聚合约束(版本1.0.6.RELEASE) 14. 增加了索引创建方式@Index,支持多字段聚合索引(版本1.0.6.RELEASE) 15. 修复query查询方法无法返回父类字段数据的bug(版本1.0.6.RELEASE) 16. 修复原本是主键,现在依然主键,修改该字段的其他信息时会报multiple primary key defined(例如id为int(11),改为int(10)后,就可重现次bug)(版本1.0.7.RELEASE) 17. 增加对字段备注的支持,使用方式@Column的comment属性(版本1.0.7.RELEASE) 18. 修复issues/IZ6WQ:bit类型的默认值设置失败,默认值可以使用0、1、true、false(版本1.0.8.1.RELEASE) 19. 修复issues/IYTJ1:使用@Unique进行联合约束,启动项目自动创建表结构后,删除联合约束报错(版本1.0.8.1.RELEASE) 20. 迭代issues/IYW9F:mybatis.model.pack支持多包扫描","或者";"隔开(版本1.0.8.1.RELEASE) 21. 修复issues/I160LP:drop拼写的问题(版本1.0.9.RELEASE) 22. 优化issues/I1IENW:@Index,@Unique创建索引和唯一约束的实现逻辑,默认会给索引名和约束名增加前缀actable_idx_和actable_uni_方便更新删除时只针对这两个前缀的进行删除更新,避免删掉手动创建的字段的索引约束 (版本1.0.9.RELEASE) 23. 修复issues/I16OZQ::@Index,@Unique在只设置了索引名称没有设置索引字段时,报错的bug,并且原有name改为value,原有value改为columns(版本1.0.9.RELEASE) 24. 迭代issues/I1IF5E:增加对tinyint/smallint/mediumint/year/blob/longblob/mediumblob/tinytext/tinyblob/binary字段类型的支持 (版本1.0.9.RELEASE) 25. 迭代issues/I1IF5Q:框架模式新增add模式,本模式下只具备,新增表/新增字段/新增索引/新增唯一约束的功能,不会做修改和删除 (版本1.0.9.RELEASE) 26. 迭代issues/I193FC:@Column的name属性改为非必填,不填默认使用属性名作为表字段名 (版本1.0.9.RELEASE) 27. 迭代issues/I193FC:@Column的type属性改为非必填,不填默认使用属性的数据类型进行转换,转换失败的字段不会添加 (版本1.0.9.RELEASE) 支持java类型转mysql类型如下: java.lang.String java.lang.Long java.lang.Integer java.lang.Boolean java.math.BigInteger java.lang.Float java.lang.Double java.math.BigDecimal java.sql.Date java.util.Date java.sql.Timestamp java.sql.Time 本次迭代至1.0.9.RELEASE,极大的简化了注解的使用复杂度,在保留原有复杂的自定义配置能力的同时,增加了更多的默认适配能力 也就是对于@Column标签如果对字段命名等没有任何要求的情况下,直接使用标签即可,无需配置类型等参数,会默认根据上面支持的类型去进行匹配转换 28. 迭代issues/I1ILS6:@IsKey/@IsAutoIncrement/@IsNotNull用来代替 @Column中的isKey/isAutoIncrement/isNull三个属性,当然旧的配置方式仍然是支持的 (版本1.0.9.RELEASE) 29. 紧急修复1.0.9.RELEASE版本CUDR的bug,请不要使用1.0.9.RELEASE版本(版本1.0.9.1.RELEASE) 30. 迭代issues/I1IVXK:BaseMysqlCRUDManager该工具类废弃,请勿使用,新增工具类BaseCRUDManager,新的insert接口取消了对主键的integer类型的限定,主键可以自由使用类型(版本1.1.0.RELEASE) 新增工具类BaseCRUDManager的方法列表如下,详细接口文档见文档结尾部分: List select(T t); T selectByPrimaryKey(T t); List selectAll(Class clasz); int selectCount(T t); T selectOne(T t); int delete(T t); int deleteByPrimaryKey(T t); boolean existsByPrimaryKey(T t); T insert(T t); T insertSelective(T t); boolean updateByPrimaryKey(T t); boolean updateByPrimaryKeySelective(T t); List query(String sql, Class beanClass); List> query(String sql); **基本使用规范** 1. 需要依赖mybatis-enhance-actable-1.1.0.RELEASE.jar ``` com.gitee.sunchenbin.mybatis.actable mybatis-enhance-actable 1.1.0.RELEASE ``` 2. 需要配置对于actable支持的配置 ``` mybatis.table.auto=update mybatis.model.pack=com.sunchenbin.store.model mybatis.database.type=mysql 本系统提供四种模式: 2.1 当mybatis.table.auto=create时,系统启动后,会将所有的表删除掉,然后根据model中配置的结构重新建表,该操作会破坏原有数据。 2.2 当mybatis.table.auto=update时,系统会自动判断哪些表是新建的,哪些字段要修改类型等,哪些字段要删除,哪些字段要新增,该操作不会破坏原有数据。 2.3 当mybatis.table.auto=none时,系统不做任何处理。 2.4 当mybatis.table.auto=add,新增表/新增字段/新增索引/新增唯一约束的功能,不做做修改和删除 (只在版本1.0.9.RELEASE及以上支持)。 2.5 mybatis.model.pack这个配置是用来配置要扫描的用于创建表的对象的包名 2.6 mybatis.database.type这个是用来区别数据库的,预计会支持这四种数据库mysql/oracle/sqlserver/postgresql,但目前仅支持mysql ``` 3. 支持actable的mybatis配置 ``` 1. classpath*:com/gitee/sunchenbin/mybatis/actable/mapping/*/*.xml 2. com.gitee.sunchenbin.mybatis.actable.dao.* ``` 4. 扫描actable的包到spring容器中管理 ``` 1. com.gitee.sunchenbin.mybatis.actable.manager.* ``` **Springboot+Mybatis的项目使用步骤方法** 1. 首先pom文件依赖actable框架 ``` com.gitee.sunchenbin.mybatis.actable mybatis-enhance-actable 1.1.0.RELEASE ``` 2. 项目的application.properties文件配置例如下面 ``` mybatis.table.auto=update mybatis.model.pack=com.sunchenbin.store.model mybatis.database.type=mysql mybatis.mapperLocations=classpath*:xxxxxx/*.xml,classpath*:com/gitee/sunchenbin/mybatis/actable/mapping/*/*.xml ``` 3. springboot启动类需要做如下配置 ``` 1. 通过注解@ComponentScan配置,扫描actable要注册到spring的包路径"com.gitee.sunchenbin.mybatis.actable.manager.*" 2. 通过注解@MapperScan配置,扫描mybatis的mapper,路径为"com.gitee.sunchenbin.mybatis.actable.dao.*" ``` **传统Spring+Mybatis的Web项目使用步骤方法** 1. 首先pom文件依赖actable框架 ``` com.gitee.sunchenbin.mybatis.actable mybatis-enhance-actable 1.1.0.RELEASE ``` 2. 在你的web项目上创建个目录比如config下面创建个文件autoCreateTable.properties文件的内容如下: ``` mybatis.table.auto=update mybatis.model.pack=com.sunchenbin.store.model mybatis.database.type=mysql ``` 3. spring的配置文件中需要做如下配置: ``` classpath*:config/autoCreateTable.properties 1. classpath*:com/gitee/sunchenbin/mybatis/actable/mapping/*/*.xml 2. com.gitee.sunchenbin.mybatis.actable.dao.* 举例这两个配置配置的详细位置 classpath*:com/sunchenbin/store/mapping/*/*.xml classpath*:com/gitee/sunchenbin/mybatis/actable/mapping/*/*.xml ``` **代码用途讲解** 1.SysMysqlColumns.java这个对象里面配置的是mysql的数据类型,这里配置的类型越多,意味着创建表时能使用的类型越多 2.LengthCount.java是一个自定义的注解,用于标记在MySqlTypeConstants.java里面配置的数据类型上的,标记该类型需要设置几个长度,如datetime/varchar(1)/decimal(5,2),分别是需要设置0个1个2个 3.LengthDefault.java时一个自定义的注解,用于跟LengthCount.java配合使用,用来标记在MySqlTypeConstants.java里面配置的数据类型上的,标记改类型如果没有设置长度时默认的长度。 4.Column.java也是一个自定义的注解,用于标记model中的字段上,作为创建表的依据如不标记,不会被扫描到,有几个属性用来设置字段名、字段类型、长度等属性的设置,详细请看代码上的注释 5.Table.java也是一个自定义的注解,用于标记在model对象上,有一个属性name,用于设置该model生成表后的表名,如不设置该注解,则该model不会被扫描到 6.Index.java是一个自定义注解,用于标记在model中的字段上,表示为该字段创建索引,有两个属性一个是设置索引名称,一个是设置索引字段,支持多字段联合索引,如果都不设置默认为当前字段创建索引 7.Unique.java是一个自定义注解,用于标记在model中的字段上,表示为该字段创建唯一约束,有两个属性一个是设置约束名称,一个是设置约束字段,支持多字段联合约束,如果都不设置默认为当前字段创建唯一约束 8.系统启动后会去自动调用SysMysqlCreateTableManagerImpl.java的createMysqlTable()方法,没错,这就是核心方法了,负责创建、删除、修改表。 9.新增注解@IsKey/@IsAutoIncrement/@IsNotNull用来代替 @Column中的isKey/isAutoIncrement/isNull三个属性,当然旧的配置方式仍然是支持的 **model的写法例子** ``` @Builder @Data @NoArgsConstructor @AllArgsConstructor @Table(name = "test") public class Test extends BaseModel{ private static final long serialVersionUID = 5199200306752426433L; // 第一种主键设置方式 @Column(name = "id",type = MySqlTypeConstant.INT,length = 11,isKey = true,isAutoIncrement = true) private Integer id; // 第二种简化的主键设置方式 @IsKey @IsAutoIncrement @Column private Integer id; // 第一种设置索引的方法,这种方法会在数据库默认创建索引名称为actable_idx_{login_name},索引字段为login_name @Index // 第二种设置索引的方法,这种方法会在数据库创建索引名称为actable_idx_{t_idx_login_name},索引字段为login_name @Index("t_idx_login_name") // 第三种设置索引的方法,这种方法会在数据库创建索引名称为actable_idx_{t_idx_login_name},索引字段为login_name @Index(value="t_idx_login_name",columns={"login_name"}) // 第四种设置索引的方法,可以设置联合索引,这种方法会在数据库创建索引名称为actable_idx_{login_name_mobile},索引字段为login_name和mobile @Index(columns={"login_name","mobile"}) // 第五种设置索引的方法,可以设置联合索引,这种方法会在数据库创建索引名称为actable_idx_{login_name_mobile},索引字段为login_name和mobile @Index(value="t_idx_login_name_mobile",columns={"login_name","mobile"}) // 唯一约束的注解的使用方法,跟@Index相同 @Unique @Column(name = "login_name",type = MySqlTypeConstant.VARCHAR,length = 111) private String loginName; // column的简化写法,不配置默认使用当前属性名作为字段名,当前类型默认转换至mysql支持的类型 @Column private String mobile; // column的简化写法,根据需要设置注解属性 @Column(name = "createTime") private Date create_time; @Column(name = "update_time",type = MySqlTypeConstant.DATETIME) private Date update_time; @Column(name = "number",type = MySqlTypeConstant.DECIMAL,length = 10,decimalLength = 2) private BigDecimal number; // 第一种设置字段非空的方法 @Column(name = "lifecycle",type = MySqlTypeConstant.CHAR,length = 1,isNull=false) // 第二种设置字段非空的方法 @IsNotNull @Column private String lifecycle; @Column private String realName; } ``` **@Column不设置类型时的默认转换规则如下(建议类型使用对象类型不要用基本数据类型)** javaToMysqlTypeMap.put("class java.lang.String", MySqlTypeConstant.VARCHAR); javaToMysqlTypeMap.put("class java.lang.Long", MySqlTypeConstant.BIGINT); javaToMysqlTypeMap.put("class java.lang.Integer", MySqlTypeConstant.INT); javaToMysqlTypeMap.put("class java.lang.Boolean", MySqlTypeConstant.BIT); javaToMysqlTypeMap.put("class java.math.BigInteger", MySqlTypeConstant.BIGINT); javaToMysqlTypeMap.put("class java.lang.Float", MySqlTypeConstant.FLOAT); javaToMysqlTypeMap.put("class java.lang.Double", MySqlTypeConstant.DOUBLE); javaToMysqlTypeMap.put("class java.math.BigDecimal", MySqlTypeConstant.DECIMAL); javaToMysqlTypeMap.put("class java.sql.Date", MySqlTypeConstant.DATE); javaToMysqlTypeMap.put("class java.util.Date", MySqlTypeConstant.DATE); javaToMysqlTypeMap.put("class java.sql.Timestamp", MySqlTypeConstant.DATETIME); javaToMysqlTypeMap.put("class java.sql.Time", MySqlTypeConstant.TIME); **共通的CUDR功能使用** 1.使用方法很简单,大家在manager或者Controller中直接注入BaseCRUDManager这个接口就可以了 2.旧的BaseMysqlCRUDManager类废弃了请不要使用 3.注意:接口调用方法时传入的对象必须是modle中用于创建表的对象才可以 **共通类BaseCRUDManager的CUDR方法接口文档如下** /** * 根据实体对象的非Null字段作为Where条件查询结果集,如果对象的属性值都为null则返回全部数据等同于selectAll * @param t 实体对象 * @param 实体对象类型 * @return List实体对象列表 */ List select(T t); /** * 根据实体对象的@IsKey主键字段的值作为Where条件查询结果,主键字段不能为null * @param t 实体对象(只设置主键值即可,其他字段值不会读取) * @param 实体对象类型 * @return 实体对象 */ T selectByPrimaryKey(T t); /** * 查询表全部数据 * @param clasz 实体对象的class * @param 实体对象类型 * @return List实体对象列表 */ List selectAll(Class clasz); /** * 根据实体对象的非Null字段作为Where条件查询结果集的Count,如果对象的属性值都为null则Count全表 * @param t 实体对象 * @param 实体对象类型 * @return 结果数量 */ int selectCount(T t); /** * 根据实体对象的非Null字段作为Where条件查询结果集,如果对象的属性值都为null则返回结果集的第一条使用的limit 1 * @param t 实体对象 * @param 实体对象类型 * @return 实体对象 */ T selectOne(T t); /** * 根据实体对象的非Null字段作为Where条件进行删除操作,如果对象的属性值都为null则删除表全部数据 * @param t 实体对象 * @param 实体对象类型 * @return 返回成功条数 */ int delete(T t); /** * 根据实体对象的@IsKey主键字段的值作为Where条件进行删除操作,主键字段不能为null * @param t 实体对象(只设置主键值即可,其他字段值不会读取) * @param 实体对象类型 * @return 返回成功条数 */ int deleteByPrimaryKey(T t); /** * 根据实体对象的@IsKey主键字段的值作为Where条件查询该数据是否存在,主键字段不能为null * @param t 实体对象(只设置主键值即可,其他字段值不会读取) * @param 实体对象类型 * @return true存在,fasle不存在 */ boolean existsByPrimaryKey(T t); /** * 根据实体对象保存一条数据,主键如果没有设置自增属性则必须不能为null * @param t 实体对象 * @param 实体对象类型 * @return 实体对象 */ T insert(T t); /** * 根据实体对象保存一条数据,如果属性值为null则不插入默认使用数据库的字段默认值,主键如果没有设置自增属性则必须不能为null * @param t 实体对象 * @param 实体对象类型 * @return 实体对象 */ T insertSelective(T t); /** * 根据实体对象主键作为Where条件更新其他字段数据,主键必须不能为null * @param t 实体对象 * @param 实体对象类型 * @return 更新结果 */ boolean updateByPrimaryKey(T t); /** * 根据实体对象主键作为Where条件更新其他字段数据,如果其他字段属性值为null则忽略更新,主键必须不能为null * @param t 实体对象 * @param 实体对象类型 * @return 更新结果 */ boolean updateByPrimaryKeySelective(T t); /** * 动态查询方法 * @param * @param sql 动态sql * @param beanClass 返回list对象类型,不传默认返回List(Map(String,Object))格式 * @return */ List query(String sql, Class beanClass); /** * 动态查询方法 * @param sql 动态sql * @return */ List> query(String sql); **BaseCRUDManager使用代码示例** ``` @Controller public class TestController{ @Autowired private TestManager testManager; @Autowired private BaseCRUDManager baseCRUDManager; /** * 首页 */ @RequestMapping("/testDate") @ResponseBody public String testDate(){ UserEntity insert = baseCRUDManager.insert(UserEntity.builder().loginName("111").build()); UserEntity insertSelective = baseCRUDManager.insertSelective(UserEntity.builder().loginName("222").build()); List userEntities1 = baseCRUDManager.selectAll(UserEntity.class); boolean b = baseCRUDManager.updateByPrimaryKey(UserEntity.builder().id(1L).mobile("1111").build()); boolean b1 = baseCRUDManager.updateByPrimaryKeySelective(UserEntity.builder().id(2L).mobile("1111").build()); UserEntity userEntity = baseCRUDManager.selectOne(UserEntity.builder().id(1L).mobile("1111").build()); UserEntity userEntity1 = baseCRUDManager.selectByPrimaryKey(UserEntity.builder().id(8L).mobile("1111").build()); List select = baseCRUDManager.select(UserEntity.builder().mobile("1111").build()); int i = baseCRUDManager.selectCount(UserEntity.builder().build()); int sss = baseCRUDManager.delete(UserEntity.builder().realName("sss").build()); int i1 = baseCRUDManager.deleteByPrimaryKey(UserEntity.builder().id(5L).loginName("222").build()); boolean b2 = baseCRUDManager.existsByPrimaryKey(UserEntity.builder().id(1L).build()); boolean b3 = baseCRUDManager.existsByPrimaryKey(UserEntity.builder().id(222L).build()); return "success"; } } ```