guns-lite 发布代码生成工具

ゞ浴缸里的玫瑰 2022-04-25 03:36 220阅读 0赞

[开发四年只会写业务代码，分布式高并发都不会还做程序员？][Link 1]  ![hot3.png][]

guns-lite发布第一版代码生成工具啦！~~

可以根据实体类生成service,repository，controller(guns-api的controller)，界面代码(vue版本界面）

## 使用方法 ##

*  准备工作

-- 克隆本项目
    git clone https://github.com/enilu/sbvue-coder.git
    
    -- 安装到本地仓库
    cd sbvue-coder
    mvn install
    
    --在guns-lite的guns-entity的pom.xml文件中添加依赖：guns-lite/guns-entity/pom.xml
    
    <dependency>
        <groupId>cn.enilu</groupId>
        <artifactId>sbvue-coder</artifactId>
        <version>1.0</version>
    </dependency>

*  在Intellij IDEA中新建一个Run Config，如下图所示 ![run config][]
    
     *  上图三个配置分别为
        
         *  1，运行的代码生成主类
         *  2，代码生成参数,详见下面说明
         *  3，在哪个模块中执行代码生成：guns-entity，因为代码生成是通过读取guns-entity中的实体类的注解实现，所以这里选择guns-entity
 *  新建配置文件：guns-entity/src/main/resources/code/code.json,配置文件内容如下，下面内容指定了生成的相关代码分别放在哪个模块下，考虑到有的同学可能会更改项目名和模块名，增加该配置，开发人员可以自行配置模块名

{
      "codeConfig": {
        "type": "cn.enilu.sbvue.code.CodeConfig",
        "fields": {
          entityModel: "guns-entity",
          daoModel: "guns-dao",
          serviceModel: "guns-service",
          controllerModel: "guns-api",
          viewModel: "guns-admin-vuejs"
        }
      }
    }

## [\#][Link 2]代码生成参数 ##

执行生成的时候，在Program arguments配置为：-h 运行后将会输出下面参数帮助提示

usage: Generator [options] [all|entity|service|controller|view]
     -f,--force               force generate file even if file exists
     -h,--help                show help message
     -i,--include <arg>       include table pattern
     -module,--module <arg>   current module name
     -p,--package <arg>       base package name,default:cn.enilu.guns
     -u,--base-uri <arg>      base uri prefix, default is /
     -x,--exclude <arg>       exclude table pattern

比如在Program arguments配置 -mudule test 将会根据guns-entity/src/main/java/cn/enilu/guns/bean/entity/test/目录下所有的java类生成其CRUD相关代码

如果程序运行参数更改为 -mudule test -i t\_test\_boy 将会根据上述目录下的Boy实体生成其相关CRUD代码，注意这里-i 后面的参数值是实体中配置的表名称，而不是实体名本身。

测试实体Boy内容如下

package cn.enilu.guns.bean.entity.test;
    import cn.enilu.guns.bean.entity.BaseEntity;
    import lombok.Data;
    import org.hibernate.annotations.Table;
    import javax.persistence.Column;
    import javax.persistence.Entity;
    
    @Entity(name="t_test_boy")
    @Table(appliesTo = "t_test_boy",comment = "男孩")
    @Data
    public class Boy extends BaseEntity {
        @Column(columnDefinition = "VARCHAR(32) COMMENT '姓名'")
        private String name;
        @Column(columnDefinition = "INT COMMENT '年龄'")
        private Integer age;
        @Column(columnDefinition = "VARCHAR(12) COMMENT '生日'")
        private String birthday;
        @Column(name = "has_girl_friend",columnDefinition = "TINYINT COMMENT '是否有女朋友'")
        private Boolean hasGirFriend;
    }

注意如果要根据实体生成代码,实体中的@Table注解要配置为@org.hibernate.annotations.Table而不是能配置为：@javax.persistence.Table,因为前者可以配置注释comment

以Boy实体为例,执行代码生成后将会生成如下文件： ![run code\_add][run code_add]

代码生成后，在guns-admin-vuejs的路由配置文件中guns-admin-vuejs/src/store/modules/permission.js，增加如下红框内容：

![run router][]

启动guns-api和guns-admin-vuejs,配置和菜单和角色权限后就可以访问刚刚生成的代码功能了 ![run code\_result][run code_result]

后续如有更新，会通过改文档说明：[http://enilu.gitee.io/guns-lite/ecosystem/code-generator.html][http_enilu.gitee.io_guns-lite_ecosystem_code-generator.html]

第一版代码生成工具只是通过控制台生成，后面会考虑通过web界面或者idea插件生成，敬请期待

[Link 1]: https://www.oschina.net/question/2663968_2304821
[hot3.png]: /images/20220210/91c2b4cfd7ca459292b47aceab495630.png
[run config]: https://static.oschina.net/uploads/img/201904/28111203_7vRb.jpg
[Link 2]: http://enilu.gitee.io/guns-lite/ecosystem/code-generator.html#%E4%BB%A3%E7%A0%81%E7%94%9F%E6%88%90%E5%8F%82%E6%95%B0
[run code_add]: https://static.oschina.net/uploads/img/201904/28111203_NiCn.jpg
[run router]: https://static.oschina.net/uploads/img/201904/28111203_zi0i.jpg
[run code_result]: https://static.oschina.net/uploads/img/201904/28111203_bops.jpg
[http_enilu.gitee.io_guns-lite_ecosystem_code-generator.html]: http://enilu.gitee.io/guns-lite/ecosystem/code-generator.html