SpringBoot代码生成器，让你释放双手，从此不用手撸代码

前言

通常在开始开发项目的时候，首先会建立好数据库相关表，然后根据表结构生成 Controller、Service、DAO、Model以及一些前端页面。

站在用户的角度思考问题，与客户深入沟通，找到南江网站设计与南江网站推广的解决方案，凭借多年的经验，让设计与互联网技术结合，创造个性化、用户体验好的作品，建站类型包括：网站设计、做网站、企业官网、英文网站、手机端网站、网站推广、域名注册、网页空间、企业邮箱。业务覆盖南江地区。

如果开发前没有强制的约束，而每个程序员都有自己的编码习惯，最终会导致一个项目呈现出多种编码风格。再有就是一些CRUD的列表功能，基本是没啥挑战性的，纯粹苦力活，浪费时间。

所以，根据公司现有框架，开发一款统一风格的代码生成器还是很有必要的。

技术选型

开发框架：SpringBoot+JPA，考虑到会生成各种前后端代码文件，这里我们选用freemarker模板引擎来制作相应的模板。

实现思路

获取表结构信息

首先我们定义一个实体类，为了使用方便，把表和字段信息放到了一个类中：

 
 
 
 
    
  
  
  
  
  1. /**
    2. 
  
  
  
  
  2. * 表以及相关字段信息
    3. 
  
  
  
  
  3. */
    4. 
  
  
  
  
  4. @Data
    5. 
  
  
  
  
  5. public class AppGen extends PageBean implements Serializable {
    6. 
  
  
  
  
  6. 
  
  
  
  
  7. /**
    8. 
  
  
  
  
  8. * 表名
    9. 
  
  
  
  
  9. */
    10. 
  
  
  
  
  10. private String tableName;
    11. 
  
  
  
  
  11. /**
    12. 
  
  
  
  
  12. * 实体类名
    13. 
  
  
  
  
  13. */
    14. 
  
  
  
  
  14. private String entityName;
    15. 
  
  
  
  
  15. /**
    16. 
  
  
  
  
  16. * 实体类名 首字母小写
    17. 
  
  
  
  
  17. */
    18. 
  
  
  
  
  18. private String lowerEntityName;
    19. 
  
  
  
  
  19. /**
    20. 
  
  
  
  
  20. * 表备注
    21. 
  
  
  
  
  21. */
    22. 
  
  
  
  
  22. private String tableComment;
    23. 
  
  
  
  
  23. /**
    24. 
  
  
  
  
  24. * 表前缀
    25. 
  
  
  
  
  25. */
    26. 
  
  
  
  
  26. private String prefix;
    27. 
  
  
  
  
  27. /**
    28. 
  
  
  
  
  28. * 功能描述
    29. 
  
  
  
  
  29. */
    30. 
  
  
  
  
  30. private String function;
    31. 
  
  
  
  
  31. 
  
  
  
  
  32. /**
    33. 
  
  
  
  
  33. * 列名
    34. 
  
  
  
  
  34. */
    35. 
  
  
  
  
  35. private String columnName;
    36. 
  
  
  
  
  36. /**
    37. 
  
  
  
  
  37. * 实体列名
    38. 
  
  
  
  
  38. */
    39. 
  
  
  
  
  39. private String entityColumnName;
    40. 
  
  
  
  
  40. /**
    41. 
  
  
  
  
  41. * 列描述
    42. 
  
  
  
  
  42. */
    43. 
  
  
  
  
  43. private String columnComment;
    44. 
  
  
  
  
  44. 
  
  
  
  
  45. /**
    46. 
  
  
  
  
  46. * 类型
    47. 
  
  
  
  
  47. */
    48. 
  
  
  
  
  48. private String dataType;
    49. 
  
  
  
  
  49. 
  
  
  
  
  50. /**
    51. 
  
  
  
  
  51. * 自增
    52. 
  
  
  
  
  52. */
    53. 
  
  
  
  
  53. private Object columnExtra;
    54. 
  
  
  
  
  54. /**
    55. 
  
  
  
  
  55. * 长度
    56. 
  
  
  
  
  56. */
    57. 
  
  
  
  
  57. private Object columnLength;
    58. 
  
  
  
  
  58. 
  
  
  
  
  59. private List list;
    60. 
  
  
  
  
  60. 
  
  
  
  
  61. }
    62.

获取表列表：

 
 
 
 
    
  
  
  
  
  1. @Override
    2. 
  
  
  
  
  2. @Transactional(readOnly = true)
    3. 
  
  
  
  
  3. public Result list(AppGen gen){
    4. 
  
  
  
  
  4. String countSql = "SELECT COUNT(*) FROM information_schema.tables ";
    5. 
  
  
  
  
  5. countSql +="WHERE table_schema='tools'";
    6. 
  
  
  
  
  6. Long totalCount = dynamicQuery.nativeQueryCount(countSql);
    7. 
  
  
  
  
  7. PageBean data = new PageBean<>();
    8. 
  
  
  
  
  8. if(totalCount>0){
    9. 
  
  
  
  
  9. String nativeSql = "SELECT table_name as tableName,table_comment as tableComment ";
    10. 
  
  
  
  
  10. nativeSql+="FROM information_schema.tables WHERE table_schema='tools'";
    11. 
  
  
  
  
  11. Pageable pageable = PageRequest.of(gen.getPageNo(),gen.getPageSize());
    12. 
  
  
  
  
  12. List list = dynamicQuery.nativeQueryPagingListModel(AppGen.class,pageable, nativeSql);
    13. 
  
  
  
  
  13. data = new PageBean<>(list, totalCount);
    14. 
  
  
  
  
  14. }
    15. 
  
  
  
  
  15. return Result.ok(data);
    16. 
  
  
  
  
  16. }
    17.

制作模板

模板太多了，这里只以Controller模板为例，贴一下实现代码，更多模板见源码：

 
 
 
 
    
  
  
  
  
  1. package com.tools.module.${prefix}.web;
    2. 
  
  
  
  
  2. 
  
  
  
  
  3. import com.tools.common.config.AbstractController;
    4. 
  
  
  
  
  4. import com.tools.common.model.Result;
    5. 
  
  
  
  
  5. import com.tools.module.${prefix}.entity.${entityName};
    6. 
  
  
  
  
  6. import com.tools.module.${prefix}.service.${entityName}Service;
    7. 
  
  
  
  
  7. import org.springframework.beans.factory.annotation.Autowired;
    8. 
  
  
  
  
  8. import org.springframework.web.bind.annotation.PostMapping;
    9. 
  
  
  
  
  9. import org.springframework.web.bind.annotation.RequestBody;
    10. 
  
  
  
  
  10. import org.springframework.web.bind.annotation.RequestMapping;
    11. 
  
  
  
  
  11. import org.springframework.web.bind.annotation.RestController;
    12. 
  
  
  
  
  12. 
  
  
  
  
  13. 
  
  
  
  
  14. @RestController
    15. 
  
  
  
  
  15. @RequestMapping("/${prefix}/${function}")
    16. 
  
  
  
  
  16. public class ${entityName}Controller extends AbstractController {
    17. 
  
  
  
  
  17. 
  
  
  
  
  18. @Autowired
    19. 
  
  
  
  
  19. private ${entityName}Service ${function}Service;
    20. 
  
  
  
  
  20. 
  
  
  
  
  21. /**
    22. 
  
  
  
  
  22. * 列表
    23. 
  
  
  
  
  23. */
    24. 
  
  
  
  
  24. @PostMapping("/list")
    25. 
  
  
  
  
  25. public Result list(${entityName} ${function}){
    26. 
  
  
  
  
  26. return ${function}Service.list(${function});
    27. 
  
  
  
  
  27. }
    28. 
  
  
  
  
  28. /**
    29. 
  
  
  
  
  29. * 查询
    30. 
  
  
  
  
  30. */
    31. 
  
  
  
  
  31. @PostMapping("/get")
    32. 
  
  
  
  
  32. public Result get(Long id){
    33. 
  
  
  
  
  33. return ${function}Service.get(id);
    34. 
  
  
  
  
  34. }
    35. 
  
  
  
  
  35. /**
    36. 
  
  
  
  
  36. * 保存
    37. 
  
  
  
  
  37. */
    38. 
  
  
  
  
  38. @PostMapping("/save")
    39. 
  
  
  
  
  39. public Result save(@RequestBody ${entityName} ${function}){
    40. 
  
  
  
  
  40. return ${function}Service.save(${function});
    41. 
  
  
  
  
  41. }
    42. 
  
  
  
  
  42. 
  
  
  
  
  43. /**
    44. 
  
  
  
  
  44. * 删除
    45. 
  
  
  
  
  45. */
    46. 
  
  
  
  
  46. @PostMapping("/delete")
    47. 
  
  
  
  
  47. public Result delete(Long id){
    48. 
  
  
  
  
  48. return ${function}Service.delete(id);
    49. 
  
  
  
  
  49. }
    50. 
  
  
  
  
  50. }
    51.

说白了其实就是传递参数，把一些可变的代码片段使用${name}形式编写。

代码生成

有点长，慢慢看，其实就是渲染各种前后端模板：

 
 
 
 
    
  
  
  
  
  1. /**
    2. 
  
  
  
  
  2. * 生成代码
    3. 
  
  
  
  
  3. * @param gen
    4. 
  
  
  
  
  4. * @return
    5. 
  
  
  
  
  5. * @throws IOException
    6. 
  
  
  
  
  6. * @throws TemplateException
    7. 
  
  
  
  
  7. */
    8. 
  
  
  
  
  8. @PostMapping("/create")
    9. 
  
  
  
  
  9. public Result create(@RequestBody AppGen gen) throws IOException, TemplateException {
    10. 
  
  
  
  
  10. /**
    11. 
  
  
  
  
  11. * 获取表字段以及注释
    12. 
  
  
  
  
  12. */
    13. 
  
  
  
  
  13. List list = genService.getByTable(gen);
    14. 
  
  
  
  
  14. String name = gen.getTableName();
    15. 
  
  
  
  
  15. String[] table = StringUtils.split(name,"_");
    16. 
  
  
  
  
  16. gen.setPrefix(table[0]);
    17. 
  
  
  
  
  17. gen.setFunction(table[1]);
    18. 
  
  
  
  
  18. gen.setEntityName(GenUtils.allInitialCapital(gen.getTableName()));
    19. 
  
  
  
  
  19. list.stream().forEach(column-> {
    20. 
  
  
  
  
  20. column.setEntityColumnName(GenUtils.secInitialCapital(column.getColumnName()));
    21. 
  
  
  
  
  21. });
    22. 
  
  
  
  
  22. gen.setList(list);
    23. 
  
  
  
  
  23. String baseFile = filePath+ SystemConstant.SF_FILE_SEPARATOR+"com"+
    24. 
  
  
  
  
  24. SystemConstant.SF_FILE_SEPARATOR+ "tools"+
    25. 
  
  
  
  
  25. SystemConstant.SF_FILE_SEPARATOR+ "module"+
    26. 
  
  
  
  
  26. SystemConstant.SF_FILE_SEPARATOR+ gen.getPrefix()+SystemConstant.SF_FILE_SEPARATOR;
    27. 
  
  
  
  
  27. /**
    28. 
  
  
  
  
  28. * 后端代码
    29. 
  
  
  
  
  29. */
    30. 
  
  
  
  
  30. File entityFile = FileUtil.touch(baseFile+"entity"+
    31. 
  
  
  
  
  31. SystemConstant.SF_FILE_SEPARATOR+gen.getEntityName()+".java");
    32. 
  
  
  
  
  32. File repositoryFile = FileUtil.touch(baseFile+"repository"+
    33. 
  
  
  
  
  33. SystemConstant.SF_FILE_SEPARATOR+gen.getEntityName()+"Repository.java");
    34. 
  
  
  
  
  34. File serviceFile = FileUtil.touch(baseFile+"service"+
    35. 
  
  
  
  
  35. SystemConstant.SF_FILE_SEPARATOR+gen.getEntityName()+"Service.java");
    36. 
  
  
  
  
  36. File serviceImplFile = FileUtil.touch(baseFile+"service"+
    37. 
  
  
  
  
  37. SystemConstant.SF_FILE_SEPARATOR+"impl"+SystemConstant.SF_FILE_SEPARATOR+
    38. 
  
  
  
  
  38. gen.getEntityName()+"ServiceImpl.java");
    39. 
  
  
  
  
  39. File controllerFile = FileUtil.touch(baseFile+"web"+
    40. 
  
  
  
  
  40. SystemConstant.SF_FILE_SEPARATOR + gen.getEntityName() + "Controller.java");
    41. 
  
  
  
  
  41. /**
    42. 
  
  
  
  
  42. * 前端代码
    43. 
  
  
  
  
  43. */
    44. 
  
  
  
  
  44. String htmlPath = filePath+
    45. 
  
  
  
  
  45. SystemConstant.SF_FILE_SEPARATOR + "templates"+
    46. 
  
  
  
  
  46. SystemConstant.SF_FILE_SEPARATOR + gen.getPrefix()+
    47. 
  
  
  
  
  47. SystemConstant.SF_FILE_SEPARATOR + gen.getFunction()+SystemConstant.SF_FILE_SEPARATOR;
    48. 
  
  
  
  
  48. File listFile = FileUtil.touch(htmlPath + "list.html");
    49. 
  
  
  
  
  49. File formFile = FileUtil.touch(htmlPath + "form.html");
    50. 
  
  
  
  
  50. /**
    51. 
  
  
  
  
  51. * 生成静态页面
    52. 
  
  
  
  
  52. */
    53. 
  
  
  
  
  53. Template template = configuration.getTemplate("html/list.ftl");
    54. 
  
  
  
  
  54. String text = FreeMarkerTemplateUtils.processTemplateIntoString(
    55. 
  
  
  
  
  55. template, gen);
    56. 
  
  
  
  
  56. FileUtil.writeString(text,listFile,"UTF-8");
    57. 
  
  
  
  
  57. template = configuration.getTemplate("html/form.ftl");
    58. 
  
  
  
  
  58. text = FreeMarkerTemplateUtils.processTemplateIntoString(
    59. 
  
  
  
  
  59. template, gen);
    60. 
  
  
  
  
  60. FileUtil.writeString(text,formFile,"UTF-8");
    61. 
  
  
  
  
  61. /**
    62. 
  
  
  
  
  62. * 生成后端代码 repository
    63. 
  
  
  
  
  63. */
    64. 
  
  
  
  
  64. template = configuration.getTemplate("java/repository.ftl");
    65. 
  
  
  
  
  65. text = FreeMarkerTemplateUtils.processTemplateIntoString(
    66. 
  
  
  
  
  66. template, gen);
    67. 
  
  
  
  
  67. FileUtil.writeString(text,repositoryFile,"UTF-8");
    68. 
  
  
  
  
  68. /**
    69. 
  
  
  
  
  69. * 生成后端代码 entity
    70. 
  
  
  
  
  70. */
    71. 
  
  
  
  
  71. template = configuration.getTemplate("java/entity.ftl");
    72. 
  
  
  
  
  72. text = FreeMarkerTemplateUtils.processTemplateIntoString(
    73. 
  
  
  
  
  73. template, gen);
    74. 
  
  
  
  
  74. FileUtil.writeString(text,entityFile,"UTF-8");
    75. 
  
  
  
  
  75. /**
    76. 
  
  
  
  
  76. * 生成后端代码 service
    77. 
  
  
  
  
  77. */
    78. 
  
  
  
  
  78. template = configuration.getTemplate("java/service.ftl");
    79. 
  
  
  
  
  79. text = FreeMarkerTemplateUtils.processTemplateIntoString(
    80. 
  
  
  
  
  80. template, gen);
    81. 
  
  
  
  
  81. FileUtil.writeString(text,serviceFile,"UTF-8");
    82. 
  
  
  
  
  82. /**
    83. 
  
  
  
  
  83. * 生成后端代码 service 实现
    84. 
  
  
  
  
  84. */
    85. 
  
  
  
  
  85. template = configuration.getTemplate("java/serviceImpl.ftl");
    86. 
  
  
  
  
  86. text = FreeMarkerTemplateUtils.processTemplateIntoString(
    87. 
  
  
  
  
  87. template, gen);
    88. 
  
  
  
  
  88. FileUtil.writeString(text,serviceImplFile,"UTF-8");
    89. 
  
  
  
  
  89. /**
    90. 
  
  
  
  
  90. * 生成后端代码 controller 实现
    91. 
  
  
  
  
  91. */
    92. 
  
  
  
  
  92. template = configuration.getTemplate("java/controller.ftl");
    93. 
  
  
  
  
  93. text = FreeMarkerTemplateUtils.processTemplateIntoString(
    94. 
  
  
  
  
  94. template, gen);
    95. 
  
  
  
  
  95. FileUtil.writeString(text,controllerFile,"UTF-8");
    96. 
  
  
  
  
  96. return Result.ok();
    97. 
  
  
  
  
  97. }
    98.

生成逻辑还是很傻瓜的，后期会慢慢优化，比如根据字段类型生成不同的表单形式，可以自定义字段是否显示等的。

小结

总的来说，还是比较容易上手的，相对于一些简单的列表功能分分钟撸出效果，开发一分钟，喝茶一整天。当然对于一些复杂的效果，还是自己一一去实现，但这并不影响生成器的实用性。

源码
https://gitee.com/52itstyle/SPTools

本文标题：SpringBoot代码生成器，让你释放双手，从此不用手撸代码
网站URL：http://www.shufengxianlan.com/qtweb/news24/25974.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

软件开发知识

分类信息网

重庆网站制作　　 　消防工程　　 　优化排名　　 　微信小程序开发　　 　腾讯香港虚拟主机　　 　乐山电信机房　　 　成都网站设计制作公司　　 　成都定制网站　　 　网页改版　　 　攀枝花网站建设　　 　资中网站建设　　 　商城系统开发　　 　四川晃众门窗　　 　成都网站改版　　 　成都建网站　　 　成都温江机房　　 　服务器机柜租用　　 　全网营销　　 　网站制作价格　　 　软文推广公司