手把手教你用最简单的方式开发属于自己的代码生成工具不依赖模板引擎

概述

有个玩笑说：“程序员的键盘只要CTL+C和CTL+V就够了”。

可见程序员工作中大部分的是重复的工作，对于重复且有规律的工作任务，我们应该想办法让代码去代替我们做。

一个合格的程序员，应该具备简化自己工作任务的能力，程序员的大部分时间应该是在研究技术提升技术，而不是整天做复制粘贴的码农工作。

今天以Java语言为例手把手教你开发一款属于自己的代码生成工具，实现以代码写代码。

需求分析

能满足各种需求场景
添加新需求尽可能操作简单
不依赖第三方jar包

设计

我们知道一般的代码生成工具都是会定义模版，然后通过模版引擎及上下文变量来生成最终的代码。所以我们的代码生成工具也将采用模版的方式生成代码。

模版设计
为了能满足多种需求场景的代码生成，及添加新需求尽可能操作简单，模版采用最简单的文本格式即常用的txt格式，通过添加不同的模版文件来实现增加新的需求
模版引擎设计
通过Java中String类的replace和replaceAll方法，实现对模版文件中变量的填充。

代码编写

以复制如下代码用于Role为例，可以看出该业务是对用户表进行分页查询的操作。当业务需求需要增加新的表时，对于新的表也需要分页查询，传统的做法是自己实现这段逻辑，这样使得代码实现样式不统一，同时每次都重新实现增加了更多的人的操作，也是的代码的错误几率增加。更好的方法是复制成熟经过产线验证的代码过来替换其中的参数为新的表即可。而这样的工作交给程序来做非常合适。

@RequestMapping(value = "/list",method = RequestMethod.POST)
@ResponseBody
public String list(PageDTO pageDTO,@FormModel("condition") User user){
    userService.listForPage(pageDTO,user);
    return JSON.toJSonString(pageDTO);
}

将成熟的代码片段制成模版文件

在项目templates目录下添加模本文件testTemplate.txt,将上面的成熟代码片段拷贝到模版文件中，使用变量（形如“${var}”）替换代码片段中的参数值即可，文件内容如下：

@RequestMapping(value = "/list",method = RequestMethod.POST)
@ResponseBody
public String list(PageDTO pageDTO,@FormModel("condition") ${bigEntityName} ${littleEntityName}){
    ${littleEntityName}Service.listForPage(pageDTO,${littleEntityName});
    return JSON.toJSonString(pageDTO);
}

编写简单的模版引擎处理
模版引擎主要逻辑在于获取上下文中的变量值，动态填充模版中的变量，然后将填充后的代码输出。

完整代码如下：

public static void main(String[] args) throws Exception {
    Map context = new HashMap<>();
    context.put("littleEntityName","role");
    context.put("bigEntityName","Role");
    context.put("author","tech-farmer");
    context.put("createTime",new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
    generateCode(context);
}

private static void generateCode(Map context) throws Exception {
    File dir = new File(TestGenerator.class.getClassLoader().getResource("templates").getPath());
    if(!dir.exists() || !dir.isDirectory() || Objects.requireNonNull(dir.listFiles()).length <=0){
        throw new RuntimeException("没有找到templates文件夹，无法生成代码");
    }
    String str;
    for (File file : dir.listFiles()) {
        System.out.println(file.getName() + " start ===========================================================================");
        try(final FileReader in = new FileReader(file);
            final BufferedReader bufferedReader = new BufferedReader(in);){
            while ((str = bufferedReader.readLine()) != null){
                for (Map.Entry entry : context.entrySet()) {
                    str = str.replaceAll("\$\{\s*"+entry.getKey().replace(".","\.")+"\s*\}",entry.getValue());
                }
                System.out.println(str);
            }
        }
        System.out.println(file.getName() + " end ===========================================================================");
    }
}

运行效果

完整控制台输出如下：

"D:Program FilesJavajdk1.8.0_212binjava.exe" -agentlib:jdwp=transport=dt_socket,address=127.0.0.1:60907,suspend=y,server=n -javaagent:C:Usersdong.chengsong.IntelliJIdea2019.2systemcaptureAgentdebugger-agent.jar -Dfile.encoding=UTF-8 -classpath "D:Program FilesJavajdk1.8.0_212jrelibcharsets.jar;D:Program FilesJavajdk1.8.0_212jrelibdeploy.jar;D:Program FilesJavajdk1.8.0_212jrelibextaccess-bridge-64.jar;D:Program FilesJavajdk1.8.0_212jrelibextcldrdata.jar;D:Program FilesJavajdk1.8.0_212jrelibextdnsns.jar;D:Program FilesJavajdk1.8.0_212jrelibextjaccess.jar;D:Program FilesJavajdk1.8.0_212jrelibextjfxrt.jar;D:Program FilesJavajdk1.8.0_212jrelibextlocaledata.jar;D:Program FilesJavajdk1.8.0_212jrelibextnashorn.jar;D:Program FilesJavajdk1.8.0_212jrelibextsunec.jar;D:Program FilesJavajdk1.8.0_212jrelibextsunjce_provider.jar;D:Program FilesJavajdk1.8.0_212jrelibextsunmscapi.jar;D:Program FilesJavajdk1.8.0_212jrelibextsunpkcs11.jar;D:Program FilesJavajdk1.8.0_212jrelibextzipfs.jar;D:Program FilesJavajdk1.8.0_212jrelibjavaws.jar;D:Program FilesJavajdk1.8.0_212jrelibjce.jar;D:Program FilesJavajdk1.8.0_212jrelibjfr.jar;D:Program FilesJavajdk1.8.0_212jrelibjfxswt.jar;D:Program FilesJavajdk1.8.0_212jrelibjsse.jar;D:Program FilesJavajdk1.8.0_212jrelibmanagement-agent.jar;D:Program FilesJavajdk1.8.0_212jrelibplugin.jar;D:Program FilesJavajdk1.8.0_212jrelibresources.jar;D:Program FilesJavajdk1.8.0_212jrelibrt.jar;D:workspacefarmer-generatortargetclasses;D:mavenrepositoryorgmybatisgeneratormybatis-generator-maven-plugin1.3.6mybatis-generator-maven-plugin-1.3.6.jar;D:mavenrepositoryorgapachemavenmaven-plugin-api3.5.0maven-plugin-api-3.5.0.jar;D:mavenrepositoryorgapachemavenmaven-model3.5.0maven-model-3.5.0.jar;D:mavenrepositoryorgcodehausplexusplexus-utils3.0.24plexus-utils-3.0.24.jar;D:mavenrepositoryorgapachecommonscommons-lang33.5commons-lang3-3.5.jar;D:mavenrepositoryorgapachemavenmaven-artifact3.5.0maven-artifact-3.5.0.jar;D:mavenrepositoryorgeclipsesisuorg.eclipse.sisu.plexus.3.3org.eclipse.sisu.plexus-0.3.3.jar;D:mavenrepositoryjavaxenterprisecdi-api1.0cdi-api-1.0.jar;D:mavenrepositoryjavaxannotationjsr250-api1.0jsr250-api-1.0.jar;D:mavenrepositoryjavaxinjectjavax.inject1javax.inject-1.jar;D:mavenrepositoryorgeclipsesisuorg.eclipse.sisu.inject.3.3org.eclipse.sisu.inject-0.3.3.jar;D:mavenrepositoryorgcodehausplexusplexus-component-annotations1.5.5plexus-component-annotations-1.5.5.jar;D:mavenrepositoryorgcodehausplexusplexus-classworlds2.5.2plexus-classworlds-2.5.2.jar;D:mavenrepositoryorgmybatisgeneratormybatis-generator-core1.3.6mybatis-generator-core-1.3.6.jar;D:mavenrepositoryorgslf4jslf4j-api1.7.32slf4j-api-1.7.32.jar;D:mavenrepositorymysqlmysql-connector-java5.1.49mysql-connector-java-5.1.49.jar;D:mavenrepositoryorgjsoupjsoup1.11.3jsoup-1.11.3.jar;D:Program FilesJetBrainsIntelliJ IDEA 2019.2.1libidea_rt.jar" com.farmer.TestGenerator
Connected to the target VM, address: '127.0.0.1:60907', transport: 'socket'
testTemplate.txt start ===========================================================================

@RequestMapping(value = "/list",method = RequestMethod.POST)
@ResponseBody
public String list(PageDTO pageDTO,@FormModel("condition") Role role){
    roleService.listForPage(pageDTO,role);
    return JSON.toJSonString(pageDTO);
}
testTemplate.txt end ===========================================================================
Disconnected from the target VM, address: '127.0.0.1:60907', transport: 'socket'

Process finished with exit code 0

总结

代码量不是很大，但思路很重要，最简单的代码生成工具是不是很简单！做个小节。

可以创建新的模版适应新的业务
模版可以是完整的类
模版可以用来生成html前端页面
模版可以用来生成其他程序语言代码

手把手教你用最简单的方式开发属于自己的代码生成工具不依赖模板引擎

Java相关栏目本月热门文章