代码生成平台Xxl-Code-Generator

Posted 2020-11-02 许雪里

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了代码生成平台Xxl-Code-Generator相关的知识，希望对你有一定的参考价值。

《代码生成平台Xxl-Code-Generator》

一、简介

1.1 概述

Xxl-Code-Generator 是一个 "controller/service/dao/mybatis/model" 多层的代码生成平台。只需要提供SQL，将会自动生成全部代码。

1.2 特性

1、简洁：界面操作，简洁直观，可快速上手；
2、轻量级：仅需提供建表SQL，即可自动完成代码生成，简洁高效；
3、多层代码生成：自动生成 "controller/service/dao/mybatis/model" 多层代码，参与到开发全流程；
4、高效：从SQL到API接口，全部代码均支持自动生成，极大提高生产力和效率；
5、在线预览：代码生成后，支持实时在线预览，直接复制使用；

1.3 下载

文档地址

中文文档

源码仓库地址

源码仓库地址	Release Download
https://github.com/xuxueli/xxl-code-generator	Download
https://gitee.com/xuxueli0323/xxl-code-generator	Download

技术交流

社区交流

1.4 环境

JDK：1.7+

二、快速入门

第一步：编译项目

项目目录结构如下：

- xxl-code-generator
    - xxl-code-generator-core   ：代码生成的Core依赖，进行SQL解析等操作；
    - xxl-code-generator-admin  ：代码生成平台，使用时，只需要部署该项目即可；

第二步：准备SQL

代码生成，是以数据库表为维度进行生成。所以，需要准备好待生成代码的表SQL脚本。
然后进入代码生成平台，将建表SQL脚本填写到 "表结构信息" 输入框即可。
（默认已经提供了一个供参考Demo表SQL脚本，可操作体验下）

技术分享图片

第二步：生成代码

点击右上角 "生成代码按钮"，即可完整多层代码的生成，非常方便；

技术分享图片

第三步：Finish

代码生成后，可在界面查看和使用 "controller/service/dao/mybatis/model" 多层源代码。部分截图如下：

技术分享图片

三、总体设计

设计思想

略

ReturnT

统一接口返回数据类型，有利于接口对接与效率提升；因此生成的多层代码交互时，采用统一ReturnT，源码如下:

import java.io.Serializable;

/**
 * common return
 * @author xuxueli 2015-12-4 16:32:31
 */
public class ReturnT<T> implements Serializable {
    public static final long serialVersionUID = 42L;

    public static final int SUCCESS_CODE = 200;
    public static final int FAIL_CODE = 500;
    public static final ReturnT<String> SUCCESS = new ReturnT<String>(null);
    public static final ReturnT<String> FAIL = new ReturnT<String>(FAIL_CODE, null);
    
    private int code;
    private String msg;
    private T data;
    
    public ReturnT(int code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public ReturnT(T data) {
        this.code = SUCCESS_CODE;
        this.data = data;
    }
    
    public int getCode() {
        return code;
    }
    public void setCode(int code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    public T getData() {
        return data;
    }
    public void setData(T data) {
        this.data = data;
    }

}

四、版本更新日志

版本 v0.0.1，新特性[2018-05-03]

1、简洁：界面操作，简洁直观，可快速上手；
2、轻量级：仅需提供建表SQL，即可自动完成代码生成，简洁高效；
3、多层代码生成：自动生成 "controller/service/dao/mybatis/model" 多层代码，参与到开发全流程；
4、高效：从SQL到API接口，全部代码均支持自动生成，极大提高生产力和效率；
5、在线预览：代码生成后，支持实时在线预览，直接复制使用；

TODO LIST

1、多模板支持：当前模板为 "SpringMVC + Mybatis + mysql" 技术栈；计划新增不同代码生成模板；
2、扩展多层：目前支持生成 "controller/service/dao/mybatis/model" 层代码；计划新增前端代码，如 "jquery、vuejs、react" 等；