代码生成器

在规模较小的公司里，大部分的项目规模不是特别大，技术实现难度不是很高，关注点更多是在业务功能的开发及保证业务流程的正确性上。当有一个新的项目来时，通常会找一个项目进行copy，删除不用的包和类，然后以此为基础，进行后续的开发，开发某个模块，就copy出一份controller、service、serviceImpl、dao、daoImpl、model、jsp，然后改变类名。
项目内40%以上的代码都是模板性的，如果用手工copy、修改的方式来实现，就太烦人也没效率，而这时就是代码生成器小展身手的时候，使用代码生成器生成模板性的代码，减少手工操作的繁琐，集中精力在业务开发上，提升开发效率，代码生成器是一个很简单的东西，一点都不高深。

一、代码生成器能干什么？

一个小型的业务项目（100张表以内），通常不需要很复杂的架构，一般就是通过单个或两个项目来实现。我们先来看下最基础的开发流程：

了解需求（项目负责人）
设计表结构（项目负责人）
创建基础框架（项目负责人）
制定开发计划，按模块分配任务（项目负责人）
进行模块开发（程序员A、B、C）
测试、上线

程序员进行模块开发的方式有以下几种：

根据表结构设计，手工创建model，然后copy UserDao改名为CompanyDao，copy UserServiceImpl改名为CompanyServiceImpl，并修改引用的UserDao为CompanyDao等；
根据表结构设计，使用工具生成model，后续步骤同1

如果不细心，总是要修改个两三遍才能让一个模块有一个架子，然后再开始进行真正关心的业务开发，而这时候时间可能已经过去了一个小时，或许更久。

程序员在开发时应该“懒”一点，如果类似的代码多次出现，不要在copy了，提取为公共的方法；如果类似的copy、修改的操作重复的出现的一个项目、不同的项目里，那就写个代码生成器吧，一键完成你手工几十步的操作。

代码生成器是用来生成有规律的代码的，就如controller、service、serviceImpl、dao、daoImpl、model、jsp的结构，用户、角色、权限等等模块都有类似的结构，代码生成器可以代替我们的copy操作，自动生成这些不同业务对象的模板代码。

二、代码生成器怎么实现？

代码生成器的实现由很多种，我们以从mysql数据库表结构生成对应代码为例来说明如何实现一个代码生成器。有以下几个重点：

提前搭建好项目基础框架，因为生成的就是基础框架的模板代码
获取某个数据库内的表及表结构信息，用于生成model及其他代码
使用freemarker进行模板生成

1、提取基础框架

如公司项目都是前后端分离的，那我就提取了一个rest-base项目作为基础框架，该框架满足绝大部分公司项目开发所需的基础功能

2、获取数据库表结构

//获取所有库
select DISTINCT(TABLE_SCHEMA) from information_schema.`TABLES`;

//获取所有表
SELECT TABLE_NAME as tableName,TABLE_COMMENT as tableComment from information_schema.`TABLES` where TABLE_SCHEMA='test';

//获取某个表的结构

select COLUMN_NAME as columnName,COLUMN_TYPE as columnType,COLUMN_DEFAULT as columnDefault,COLUMN_COMMENT as columnComment,CHARACTER_MAXIMUM_LENGTH as columnCharacterMaximumLength from information_schema.columns where table_schema = 'test' and table_name = 'rule';

通过查询information_schema库内的TABLES、columns表，可以获取数据内的表、表字段属性等。然后就可以以此来确定model的内容，如表user_role对应的实体就是UserRole，表字段和实体属性可以根据类型和规则进行映射。

3、freemarker生成模板代码

先大致讲下思路：

根据表明，按规则获取实体名称，从而也确认了dao、service等的类名；
将表字段转为map结构，作为参数传入model对于的模板内，从而生成对应的model类；
依次传入参数，通过模板生成dao、service等代码

需要会一点freemarker的语法，基本上看个一小时就达到了写简单模板的程度了。

接口：

public interface GeneratorHelperService {

    /**
     * 设置公共参数，如
     * projectPath 要生成代码的项目的路径：  D:/workspace/code-generator
     * packagePath 要生成代码的项目的包的根路径：/src/main/java/com/hexun/bdc/generator
     * templetePath 本项目内代码模板路径： /src/main/resources/code-templete
     */
    boolean setProperty(Map map);

    /**
     * 生成某个库内所有表对应的代码
     * @author yangwenkui
     * @time 2017年10月29日 下午8:22:35
     * @param dbname 数据库名称
     * @return
     */
    boolean allTables(String dbname);

    /**
     * 生成某个库内某个表对应的代码
     * @author yangwenkui
     * @time 2017年10月29日 下午8:22:35
     * @param dbname 数据库名称
     * @param tableName 表名称
     * @return
     */
    boolean oneTable(String dbname, String tableName);

}

实现：

@Service("generatorHelperService")
public class GeneratorHelperServiceImpl implements GeneratorHelperService {

    private static Logger logger = LoggerFactory
            .getLogger(GeneratorHelperServiceImpl.class);

    private static Map propertyMap = Maps.newConcurrentMap();

    @Autowired
    GeneratorHelperDao generatorHelperDao;
    
    @Value("${generator.project.path}")
    private String localProjectPath;

    @Override
    public boolean setProperty(Map map) {
        propertyMap.putAll(map);
        return true;
    }

    @Override
    public boolean allTables(String dbname) {
        List