13 Star 70 Fork 27

plume开源社区 / Plumecode

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

PlumeCode

star fork License java version

一个简单易用且功能强大的代码生成器(Java & ElementUI),熟练使用你就是CURD代码挖掘机!!!

 ⭐⭐⭐新项目,需要大家的支持,欢迎Star、PR、Issue⭐⭐⭐  

PlumeCode 不仅简单、而且强大

  • 支持多数据库Mysql、H2、SqlServer、Oracle、PostgreSQL、MariaDB
  • 支持多种持久层框架MybatisPlus、Mybatis、Jpa、tk-Mybatis、Hibernate
  • 一键下载拥有portal、controller、service、repository、mapper、dto、entity、vo、query、mapper.xml等前后端代码
  • 良好的项目结构,让二次开发变得像喝水一样简单

quick start with cli

cli

quick start with web

jar包运行

  • 发行版下载
  • 启动项目
    java -jar plume-code-web-0.0.3.jar start

docker运行

docker pull yinyansheng/plumecode:v0.0.3
docker-pull
docker run -d yinyansheng/plumecode:v0.0.3
docker-run

功能简介

生成代码示例

plume-code-sample

联系交流

  • QQ群:691455148

测试地址

生成代码结构

后端框架

对于java后端项目框架设计,目前主要有两种:

  • 面向领域(DDD)
  • 面向数据(三层框架)

一般而言互联网后端C端业务并不复杂(相对B端或企业级项目),且通常也做了微服务,业务边界划分良好的话,DDD并不是一个好的选择,所以本项目基于三层框架生成后端代码

  • controller层(controller、vo、query)
  • servicer层(service、serviceImpl、dto)
  • repository层(repository/mapper/dao、repositoryImpl/daoImpl、entity)

下面是我常用的系统分层设计(参考自阿里巴巴代码规约)
project layer
以及我常用的包结构设计
package
以上都是个人理解,对于系统设计,没有银弹,适合的,符合场景的实践才是好的

前端框架

由于前端代码公司间差异比较大,这里只是做了ElementUI的示例,如有需要,可根据实际前端技术选型,做二次开发集成

项目结构

framework

二开说明

新增数据库

项目本身是基于JDBC获取数据库信息,数据库需要有JDBC实现

获取数据信息有两种方式

  • 通过JDBC Connection 获取DatabaseMetaData,从而获取数据库、表、字段、主键信息(推荐),只需要继承MetaDataDatabaseBehavior,且提供一个获取数据库名称的SQL即可
  • 通过JDBC执行Raw SQL获取数据库、表、字段、主键信息

database behavior class

Sample:新增PostgreSQL

@Component
@Scope(value = "prototype")
public class PostgreSQLDatabaseBehavior extends MetaDataDatabaseBehavior {

    @Override
    protected String getDatabaseNameSql() {
        return "SELECT current_database();";
    }
}

新增模板

tempalte behavior class 默认使用Velocity模板引擎、FreeMarker可选
新增模板文件
template file

新增后端java、xml模板实现类,继承JavaGeneratorBehavior类

@Component
@Scope("prototype")
class JpaControllerGeneratorBehavior extends JavaGeneratorBehavior {
	
    //获取模板文件名
    @Override
    protected String getTemplateName() {
        return "Jpa-Controller.java.tpl";
    }
	
    //获取文件包名(也是文件相对路径)
    @Override
    protected String getPackageName() {
        return settingModel.getBasePackageName().concat(".admin.controller");
    }

    //获取文件名
    @Override
    protected String getFileName() {
        return String.format("%sController.java", upperFirstCase(classModel.getName()));
    }
}

新增前端js、vue模板实现类,继承VueGeneratorBehavior类

@Component
@Scope("prototype")
public class ElementUiTableGeneratorBehavior extends VueGeneratorBehavior {
    //文件路径在基类中已经实现,如有调整需要重写父类getFilePath方法
    
    //获取文件名
    @Override
    protected String getFileName() {
        return "Table.vue";
    }
	
    //获取模板文件名
    @Override
    protected String getTemplateName() {
        return "ElementUi-Table.vue.tpl";
    }
}

模板上下文变量

protected Map<String, Object> getTemplateContext() {
    Map<String, Object> templateContext = new HashMap<>(32);

    SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    templateContext.put("setting", settingModel);
    templateContext.put("createTime", simpleDateFormat.format(new Date()));
    templateContext.put("className", classModel.getName());
    templateContext.put("ClassName", upperFirstCase(classModel.getName()));
    templateContext.put("tableName", classModel.getTableName());
    templateContext.put("author", settingModel.getAuthor());
    templateContext.put("comment", classModel.getComment());
    templateContext.put("lombok", settingModel.getLombokState());
    templateContext.put("fieldModelList", fieldModelList);
    templateContext.put("isMultiplePK", fieldModelList.stream().filter(FieldModel::isPk).count() > 1);
    templateContext.put("primaryKeyList", fieldModelList.stream().filter(FieldModel::isPk).collect(Collectors.toList()));

    return templateContext;
}

如果有额外的变量,可以在模板实现类中重写基类getTemplateContext方法

@Override
protected Map<String, Object> getTemplateContext() {
    Map<String, Object> templateContext = super.getTemplateContext();

    templateContext.put("basePackageName", settingModel.getBasePackageName());
    templateContext.put("packageName", getPackageName());

    String servicePackageName = settingModel.getBasePackageName().concat(".service");
    templateContext.put("servicePackageName", servicePackageName);

    templateContext.put("typePackageNameList", getTypePackageNameList());
    return templateContext;
}

修改portal页面

Road Map

0.0.1 version

  • 支持 mysql、h2 --done
  • 支持 element-ui --done
  • 支持mybatis、mybatis-plus、jpa --done
  • 支持预览代码、获取代码 --done

0.0.2 version

  • 支持联合主键 --done
  • 支持sqlserver、oracle、PostgreSQL --done
  • 支持hibernate、tk-Mybatis --done
  • 支持Query 后缀配置 --done
  • 支持VO 后缀配置 --done
  • 支持DTO后缀配置 --done
  • 支持Entity后缀配置 --done
  • 支持Lombok --done

0.0.3 version

  • 支持cli运行 --done

0.0.4 version

  • 支持docker部署(部署plume-code) --done
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

一个简单易用且功能强大的代码生成工具 (a simple and powerful code generator) 展开 收起
Apache-2.0
取消

发行版 (3)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/plumeorg/plume-code.git
git@gitee.com:plumeorg/plume-code.git
plumeorg
plume-code
Plumecode
main

搜索帮助