本站建设：代码生成starter

文章来源：原创   作者：临窗旋墨   发布时间：2021-06-22   阅读：1157   标签：starter,springboot

003-编码代码生成starter

2020-04-01

说明： 初始的代码生成是直接放在boot-war-web项目的pers.vic.boot.console.generator模块下的， 个人觉得应该抽离成一个starter，更方便集成一些。

另：boot-starter-generator 既可以作为starter集成， 也可以下放开 GeneratorApplication.java上的@SpringBootApplication从而独立运行

一 生成代码的基本思路

  1. 连接数据库获取数据库表的全部信息(本项目暂只实现mysql版本)
    • 支持多种数据库,定义dao接口,不同的数据库做不同的实现,根据配置文件指定Primary
  2. 解析表的基本信息,列的基本信息映射成对象
  3. 编写各层模板(本项目使用的是velocity),根据解析的数据对模板进行填充
  4. 导出填充后的模板

二 boot-starter-generator 的简单说明

1 配置文件 参考 generator-config.properties
  1. #代码生成器，配置信息
  2. #包名
  3. generator.packageName=pers.vic.boot.console
  4. #模块名
  5. generator.moduleName=system
  6. #作者
  7. generator.author=Vic.xu
  8. #Email
  9. generator.email=xuduochoua@163.com
  10. #表前缀(类名不会包含表前缀)
  11. generator.tablePrefix=t_
  13. #实体中忽略的字段(在基类中的字段) 另:列名转换成属性名的时候 is_delete格式会变成delete
  14. #generator.ignores=id,is_enable,is_delete,create_time,update_time
  15. generator.ignores=ID,CREATE_USER_ID,CREATE_TIME,LAST_UPDATE_USER_ID,LAST_UPDATE_TIME,ENABLE_FLAG
  18. #需要填充的模板
  19. generator.templates[0]=generator/templates/Entity.java.vm
  20. generator.templates[1]=generator/templates/Mapper.java.vm
  21. generator.templates[2]=generator/templates/Mapper.xml.vm
  22. generator.templates[3]=generator/templates/Service.java.vm
  23. generator.templates[4]=generator/templates/Controller.java.vm
  25. #数据类型转换，配置信息:数据库类型->java类型
  26. generator.dataTypeConvert.tinyint=Integer
  27. generator.dataTypeConvert.smallint=Inteer
  28. generator.dataTypeConvert.mediumint=Integer
  29. generator.dataTypeConvert.int=Integer
  30. generator.dataTypeConvert.integer=Integer
  31. generator.dataTypeConvert.bigint=Long
  32. generator.dataTypeConvert.float=Float
  33. generator.dataTypeConvert.double=Double
  34. generator.dataTypeConvert.decimal=BigDecimal
  35. generator.dataTypeConvert.bit=Boolean
  36. generator.dataTypeConvert.enum=String
  38. generator.dataTypeConvert.char=String
  39. generator.dataTypeConvert.varchar=String
  40. generator.dataTypeConvert.tinytext=String
  41. generator.dataTypeConvert.text=String
  42. generator.dataTypeConvert.mediumtext=String
  43. generator.dataTypeConvert.longtext=String
  45. generator.dataTypeConvert.date=Date
  46. generator.dataTypeConvert.time=Date
  47. generator.dataTypeConvert.datetime=Date
  48. generator.dataTypeConvert.timestamp=Date
2 代码生成starter 入口 GeneratorAutoconfigigure
  • 根据配置的generator.database 数据库类型， 注册不同的GeneratorDao实现类，本项目暂时已经实现了mysql版本的GeneratorDao；dao的对数据库的查询操作使用的是jdbcTemplate
  1. /**
  2.  * @description: 代码生成starter 入口
  3.  * @author: Vic.xu
  4.  * @date: 2020年3月10日 上午10:54:39
  5.  */
  6. @Configuration
  7. @ConditionalOnClass(value = { JdbcTemplate.class })
  8. @ConditionalOnWebApplication
  9. @ConditionalOnExpression("${generatir.enabled:true}")
  10. @EnableConfigurationProperties(GeneratorProperties.class)
  11. public class GeneratorAutoconfigigure {
  13.     /**
  14.      * 本项目中支持的各个数据库类型
  15.      */
  16.     @Autowired
  17.     private Collection<GeneratorDao> generatorDaoList;
  19.     /**
  20.      * 当前配置的数据库类型 默认MYSQL
  21.      */
  22.     @Value("${generator.database:mysql}")
  23.     private String database;
  25.     @Primary
  26.     @Bean
  27.     public GeneratorDao getGeneratorDao() {
  28.         DatabaseType type = DatabaseType.getByName(database);
  29.         Assert.notNull(type, "当前项目未支持" + database + "类型的数据库代码生成");
  30.         GeneratorDao dao = null;
  31.         for(GeneratorDao generatorDao : generatorDaoList) {
  32.             if(type == generatorDao.databaseType()) {
  33.                 dao = generatorDao;
  34.                 break;
  35.             }
  36.         }
  37.         Assert.notNull(dao, "当前项目未实现" + database + "类型的数据库的GeneratorDao");
  39.         return dao;
  40.     }
  42. }
  • 配置类GeneratorProperties
  1. /** 
  2.  * @description: 附件配置项
  3.  * @author: Vic.xu
  4.  * @date: 2019年12月11日 上午9:33:21
  5.  */
  6. @Configuration
  7. @ConfigurationProperties(prefix = GeneratorProperties.GENERATOR_PREFIX)
  8. @PropertySource("classpath:config/generator-config.properties")
  9. @JsonIgnoreProperties({"beanExpressionResolver"})
  10. public class  GeneratorProperties implements Serializable{
  11.     private static final long serialVersionUID = 1L;
  13.     public static final String GENERATOR_PREFIX = "generator";
  15.     @Value("${generator.database:mysql}")
  16.     private String database;
  18.     /**
  19.      * 包名
  20.      */
  21.     private String packageName;
  23.     /**
  24.      * 包名
  25.      */
  26.     private String moduleName;
  28.     /**
  29.      * 作者
  30.      */
  31.     private String author;
  33.     /**
  34.      * email
  35.      */
  36.     private String email;
  38.     /**
  39.      * 表前缀 若存在则生成的实体名会去掉前缀
  40.      */
  41.     private String tablePrefix;
  43.     /**
  44.      * 实体中忽略的表字段
  45.      */
  46.     private Set<String> ignores;
  47.     /**
  48.      * 大文本类型的数据库数据格式,不应该出现在列表页
  49.      */
  50.     private Set<String> textTypes;
  52.     /**
  53.      * 需要填充的数据模板
  54.      */
  55.     private List<String> templates;
  57.     /**
  58.      * 数据类型转换 数据库类型--> java 类型
  59.      */
  60.     private Map<String, String> dataTypeConvert;
  63.     @Override
  64.     public String toString() {
  65.         return "GeneratorProperties [packageName=" + packageName + ",\n moduleName=" + moduleName + ",\n author=" + author
  66.                 + ",\n email=" + email + ",\n tablePrefix=" + tablePrefix + ",\n ignores=" + ignores + ",\n templates="
  67.                 + templates + ",\n dataTypeConvert=" + dataTypeConvert + "]";
  68.     }
  70.     public String getPackageName() {
  71.         return packageName;
  72.     }
  74.     public String getModuleName() {
  75.         return moduleName;
  76.     }
  78.     public String getAuthor() {
  79.         return author;
  80.     }
  82.     public String getEmail() {
  83.         return email;
  84.     }
  86.     public String getTablePrefix() {
  87.         return tablePrefix;
  88.     }
  90.     public Set<String> getIgnores() {
  91.         return ignores;
  92.     }
  96.     public List<String> getTemplates() {
  97.         return templates;
  98.     }
  100.     public Map<String, String> getDataTypeConvert() {
  101.         return dataTypeConvert;
  102.     }
  104.     public void setPackageName(String packageName) {
  105.         this.packageName = packageName;
  106.     }
  108.     public void setModuleName(String moduleName) {
  109.         this.moduleName = moduleName;
  110.     }
  112.     public void setAuthor(String author) {
  113.         this.author = author;
  114.     }
  116.     public void setEmail(String email) {
  117.         this.email = email;
  118.     }
  120.     public void setTablePrefix(String tablePrefix) {
  121.         this.tablePrefix = tablePrefix;
  122.     }
  124.     public void setIgnores(Set<String> ignores) {
  125.         this.ignores = ignores;
  126.     }
  128.     public void setTemplates(List<String> templates) {
  129.         this.templates = templates;
  130.     }
  132.     public void setDataTypeConvert(Map<String, String> dataTypeConvert) {
  133.         this.dataTypeConvert = dataTypeConvert;
  134.     }
  136.     /**
  137.      * @return the database
  138.      */
  139.     public String getDatabase() {
  140.         return database;
  141.     }
  143.     /**
  144.      * @param database the database to set
  145.      */
  146.     public void setDatabase(String database) {
  147.         this.database = database;
  148.     }
  150.     /**
  151.      * @return the textTypes
  152.      */
  153.     public Set<String> getTextTypes() {
  154.         return textTypes;
  155.     }
  157.     /**
  158.      * @param textTypes the textTypes to set
  159.      */
  160.     public void setTextTypes(Set<String> textTypes) {
  161.         this.textTypes = textTypes;
  162.     }
  164. }
3 测试代码生成GeneratorTest

暂时生成的zip中的文件是放在一个文件夹下，并未分包，可根据需要修改此逻辑

  1. //查询当前数据库的表列表
  2. public void list() {}
  3. // 某个表的详情
  4. public void detail() {}
  5. // 导出某个或者多个表生成的
  6. public void export() {}
4 生成的文件包含

  1. 实体依赖BaseEntity等

    1. public class DevelopPlan extends BaseEntity {}

  2. mybatis的xml，包含页面列查询，详情查询，新增，修改，删除等基本操作，参见BaseMapper接口

  3. mapper：依赖BaseMapper

    1. public interface DevelopPlanMapper extends BaseMapper<DevelopPlan> {
    2. }

  1. service依赖BaseService

    1. @Service
    2. public class DevelopPlanService extends BaseService<DevelopPlanMapper, DevelopPlan>{}

  1. controller依赖BaseController

    1. @RestController
    2. @RequestMapping("/develop/plan")
    3. public class DevelopPlanController extends BaseController<DevelopPlanService, DevelopPlan>{}

三 自动生成的starter的页面 ， 使用thymeleaf编写,简单内置页面导出功能

后台管理地址：console.xuqiudong.cc

image-20210917162635503

本项目gitee源码地址

本项目主要生成的模板包括：mapper，mapper.xml， service， controller， 以及前端的list.html和form.html, 可以根据吱声需要 重写generator.templates下的模板文件

发表评论

目录