1 Star 0 Fork 0

有理想的鱼 / ymate-maven-plugin

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

YMATE-MAVEN-PLUGIN

Maven Central status LICENSE

本项目为基于 YMP - 轻量级 Java 应用开发框架 开发的小伙伴儿们提供的一系列 Maven 插件工具,辅助快速生成代码与服务等。

Maven包依赖

<plugin>
    <groupId>net.ymate.maven.plugins</groupId>
    <artifactId>ymate-maven-plugin</artifactId>
    <version>1.0.2</version>
</plugin>

命令行格式

mvn ymate:<命令> -D<参数1>=<值1> -D<参数n>=<值n>

命令列表

命令 说明
apidocs 接口文档生成器
configuration 配置体系目录结构生成器
crud CRUD 代码生成器
dbquery 数据库 SQL 查询
decrypt 字符串解密
encrypt 字符串加密
entity 数据实体代码生成器
interceptor 拦截器类生成器
module 模块代码生成器
tomcat Tomcat 服务配置生成器
validator 验证器类生成器

插件命令详解

apidocs

接口文档生成器。

参数列表

参数名称 必须 说明
packageNames 扫描包名称集合,默认为 ${project.groupId} ,多个用 , 分隔
format 输出格式,默认值:markdown,取值范围: htmlgitbookpostmanjsonmarkdown
outputDir 输出路径,默认为当前项目基准路径
language 自定义语言,默认值:空,系统语言环境
overwrite 是否覆盖已存在的文件,默认值:false
ignoredRequestMethods 忽略的请求方法名称集合,如:options

命令示例

mvn ymate:apidocs -Dformat=postman -Doverwrite=true

configuration

配置体系目录结构生成器。

参数列表

参数名称 必须 说明
homeDir 配置体系根路径,默认为当前项目基准路径,若指定路径不存在则创建
projectName 项目名称,默认值:空
moduleNames 模块名称集合,默认值:空,多个用 , 分隔
pluginNames 插件名称集合,默认值:空,多个用 , 分隔
repair 是否执行缺失文件修复(除目录结构自动补全外,该参数将对缺失的文件进行补全),默认值:false

命令示例

mvn ymate:configuration -DprojectName=default -DmoduleNames=webapp,demo -Drepair=true

crud

CRUD 代码生成器。

通过规则配置文件自动生成控制器(Controller)、存储器(Repository)和页面视图(UI)等相关代码。

参数列表

参数名称 必须 说明
file 规则配置文件,默认值:misc/crud.json
action 指定本次生成哪些代码,默认为控制器和存储器,取值范围:controllerrepositoryuiui-cdn
filter 指定本次仅生成列表中API或表的代码,默认值:空,多个名称之间用 , 分隔
fromDb 是否通过数据库表结构生成规则配置文件,默认值:false
simple 是否生成规则配置文件样例,默认值:false
apidocs 是否使用 API 文档注解,默认值:false
test 是否生成单元测试代码,默认值:false
language 自定义语言,默认值:空,系统语言环境

命令示例

  • 生成规则配置文件样例
mvn ymate:crud -Dsimple=true
  • 根据数据库表结构生成规则配置文件
mvn ymate:crud -DfromDb=true
  • 代码生成
mvn ymate:crud

dbquery

数据库 SQL 查询。

参数列表

参数名称 必须 说明
sql SQL 查询语句(必须是 SELECT 语句)
dataSource 指定数据源名称,默认值:default
format 结果集输出格式,可选值:tablemarkdowncsv,默认值:table
dateColumns 指定需转换为日期格式的字段名,默认值:空,多个名称之间用 , 分隔
page 查询页号,默认值:0
pageSize 分页大小,默认值:20

命令示例

mvn ymate:dbquery -Dsql="select * from ym_user" -Dpage=1 -Dformat=csv

decrypt

字符串解密。

参数列表

参数名称 必须 说明
content 待解密字符串
passkey 自定义密钥,默认值:空
implClass 自定义密码处理器接口实现类名,默认值:空

命令示例

mvn ymate:decrypt -Dcontent=D3ytOQrD63BlKGDMJnaYsQ==

encrypt

字符串加密。

参数列表

参数名称 必须 说明
content 待加密字符串
passkey 自定义密钥,默认值:空
implClass 自定义密码处理器接口实现类名,默认值:空

命令示例

mvn ymate:encrypt -Dcontent=abc12345678

entity

数据实体代码生成器。

更详尽的说明请参考文档:JDBC - 自动生成实体类

参数列表

参数名称 必须 说明
dev 是否使用开发模式,默认为 false
overwrite 是否覆盖已存在的文件,默认为 false
cfgFile 加载指定的框架初始化配置文件,默认为空
dataSource 指定数据源名称,默认为 default
view 是否为视图,默认为 false
showOnly 是否仅在控制台输出结构信息(不生成任何文件),默认为 false
format 控制台输出格式,配合 showOnly 使用
可选值:tablemarkdowncsv,默认为 table
beanOnly 是否仅生成 JavaBean(非实体类),默认为 false
apidocs 是否使用 @ApiProperty 文档注解,配合 beanOnly 使用,默认为 false

命令示例

mvn ymate:entity

interceptor

拦截器类生成器。

参数列表

参数名称 必须 说明
name 拦截器名称
packageName 拦截器包名,默认值:${project.groupId}

命令示例

mvn ymate:interceptor -Dname=Demo

module

模块代码生成器。

参数列表

参数名称 必须 说明
name 模块名称
packageName 模块包名,默认值:${project.groupId}
projectName 工程构件标识,默认值:${project.artifactId}

命令示例

mvn ymate:module -Dname=Demo

tomcat

Tomcat 服务配置生成器。

参数列表

参数名称 必须 说明
serviceName 服务名称(若在 Windows 环境下同时为注册服务名称)
catalinaHome Tomcat 软件包安装路径,默认值:${env.CATALINA_HOME}
catalinaBase 生成的服务存放的位置,默认为当前路径
hostName 主机名称,默认值:localhost
hostAlias 别名,默认值:
tomcatVersion 指定 Tomcat 软件包的版本,默认值:8
目前支持:678910
serverPort 服务端口,默认值:8005
connectorPort 容器端口,默认值:8080
redirectPort 重定向端口,默认值:8443
ajp 是否启用 AJP 配置,默认值:false
ajpHost AJP 主机名称,默认值:localhost
ajpPort AJP 端口,默认值:8009

命令示例

mvn ymate:tomcat -DserviceName=DemoServer -DcatalinaHome=/Users/.../apache-tomcat-8.5.75

生成的文件说明:

文件名称 说明
conf/server.xml Tomcat 服务配置文件
vhost.conf 与 Nginx 和 Apache Server 整合所需配置
bin/install.bat Windows 环境下服务安装脚本
bin/manager.bat Windows 环境下启动 Tomcat 服务管理器脚本
bin/shutdown.bat Windows 环境下服务停止脚本
bin/startup.bat Windows 环境下服务启动脚本
bin/uninstall.bat Windows 环境下服务卸载脚本
bin/manager.sh Linux 环境下控制服务的启动或停止等操作脚本
webapps/ROOT/index.jsp 默认首页文件

Linux 下服务的启动和停止:

  • 为脚本添加执行权限:

    chmod +x manager.sh
  • 启动服务:

    ./manager.sh start
  • 停止服务:

    ./manager.sh stop

validator

验证器类生成器。

参数列表

参数名称 必须 说明
name 验证器名称
packageName 验证器包名,默认值:${project.groupId}

命令示例

mvn ymate:validator -Dname=Demo

One More Thing

YMP 不仅提供便捷的 Web 及其它 Java 项目的快速开发体验,也将不断提供更多丰富的项目实践经验。

感兴趣的小伙伴儿们可以加入官方 QQ 群:480374360,一起交流学习,帮助 YMP 成长!

如果喜欢 YMP,希望得到你的支持和鼓励!

Donation Code

了解更多有关 YMP 框架的内容,请访问官网:https://ymate.net

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.

简介

本项目为基于 YMP 轻量级 Java 应用开发框架开发的小伙伴儿们提供的一系列 Maven 插件工具,辅助快速生成代码与服务等。 展开 收起
Java 等 3 种语言
Apache-2.0
取消

发行版 (3)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/suninformation/ymate-maven-plugin.git
git@gitee.com:suninformation/ymate-maven-plugin.git
suninformation
ymate-maven-plugin
ymate-maven-plugin
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891