2 Star 9 Fork 10

sagframe / sagacity-quickvo

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

sagacity-quickvo 是sqltoy-orm配套的POJO生成工具

当前版本

<!-- https://mvnrepository.com/artifact/com.sagframe/sqltoy-quickvo -->
<dependency>
    <groupId>com.sagframe</groupId>
    <artifactId>sqltoy-quickvo</artifactId>
    <version>5.2.0</version>
</dependency>

使用方式

  • 请参见 https://github.com/sagframe/sqltoy-quickstart

  • 在tools/quickvo 目录下面,配置quickvo.xml 设置相关任务信息,点击quickvo.bat 生成POJO

  • 参照下面的例子:注意根据项目实际情况决定是否要严格分entity和dto(vo)两层

<?xml version="1.0" encoding="UTF-8"?>
<quickvo xmlns="http://www.sagframe.com/schema/quickvo"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.sagframe.com/schema/quickvo http://www.sagframe.com/schema/sqltoy/quickvo.xsd">
	<!-- db配置文件 -->
	<property file="db.properties" />
	<property name="project.version" value="1.0.0" />
	<property name="project.name" value="sqltoy-strict" />
	<property name="project.package" value="com.strict.modules" />
	<property name="include.schema" value="false" />
	<!-- set method 是否支持返回对象自身(默认是true),即: public VO setName(String name){this.name=name;return this;} -->
	<property name="field.support.linked.set" value="false" />
	<!-- 是否在抽象类中生成SelectFieldImpl内部类,默认值为false	-->
	<property name="generate.selectFields.class" value="false" />
	<!-- 定义公共字段属性 -->	
	<property name="commonFields" value="createBy,createTime,updateBy,updateTime"/>
	<!-- 演示自定义类似swagger api文档注释实现,配合task定义中的api-doc="custom" 使用
	     当然这里是演示,正常task中的api-doc 有swagger-v3、swagger-v2默认选项
	 -->
	<api-doc>
		<imports value="io.swagger.v3.oas.annotations.media.Schema" />
		<doc-class-template>
		<![CDATA[@Schema(name="${className}",description="${tableRemark}")]]>
		</doc-class-template>
                <!-- 固化属性: colName, colRemark, nullable, fieldType, fieldName, defaultValue  -->
		<doc-field-template>
		<![CDATA[@Schema(name="${fieldName}",description="${colRemark}",nullable=${nullable})]]>
		</doc-field-template>
	</api-doc>
	<!-- schema 对照关系:mysql 对应 db 名称; oracle 对应 用户名称,如出现字段重复等情况,请结合schema和catalog进行配置过滤 -->
	<!-- 注意:当在多schema或tablespace场景下,在POJO中会出现重复字段,是因为schema和catalog 配置不正确,没有完成隔离 -->
	<datasource name="strict" url="${db.url}" driver="${db.driver_class}" 
		schema="${db.schema}" catalog="${db.schema}" username="${db.username}" password="${db.password}" />
	
	<tasks dist="../../src/main/java" encoding="UTF-8">
		<task active="true" author="zhongxuchen" include="^SAG_\w+" datasource="strict" api-doc="swagger-v3|swagger-v2|custom|false">
		    <!-- 
                     entity 配置中存在has-abstract:默认为true,可以设置为false表示pojo不需要抽象类,
		     可以设置extends="package.parentClass"指定父类 
		     skip-extends-fields="${commonFilelds}"   lombok="true" lombok-chain="true"
                    -->
		    <entity package="${project.package}.sagacity.entity" substr="Sag" name="#{subName}"/>
		    <!-- 在pojo和vo严格分层情况下,VO支持 lombok="true" lombok-chain="true" 避免生成get/set,
                         to-dir: 支持 extends指定父类
			 skip-extends-fields="${commonFilelds}" 
		     -->
		     <vo package="${project.package}.sagacity.vo" substr="Sag" name="#{subName}VO" />
		</task>
		<task active="true" author="zhongxuchen" include="^SYS_\w+" datasource="strict" swagger-model="true">
		     <entity package="${project.package}.system.entity" substr="Sys" name="#{subName}"/>
		     <vo package="${project.package}.system.vo" substr="Sys" name="#{subName}VO" />
		</task>
	</tasks>
	<!-- 主键策略配置: identity类型的会自动产生主键策略,其他场景sqltoy根据主键类型和长度自动分配相应的策略方式. 
	     strategy分:sequence\assign\generator 三种策略:
	     sequence 需要指定数据库对应的sequence名称。 
	     assign 为手工赋值
	     generator为指定具体产生策略,目前分:default:22位长度的主键\nanotime:26位纳秒形式\snowflake雪花算法\uuid\redis -->
	<primary-key>
		<table name="SAG_\w+|SYS_\w+" strategy="generator" generator="default" />
		<!--<table name="xxxTABLE" strategy="sequence" sequence="SEQ_XXXX"/> -->
		<!--<table name="sys_staff_info" strategy="generator" generator="snowflake"/> -->
	</primary-key>

	<!-- 基于redis产生有规则的业务主键 -->
	<business-primary-key>
		<!-- 1位购销标志_2位设备分类代码_6位日期_3位流水 (如果当天超过3位会自动扩展到4位) -->
		<!-- 业务主键可以充当实际的主键,如果字段是主键会覆盖原来的主键策略 -->
		<!-- 包含的三个宏: @substr(${field},startIndex,length) @case(value,case1,value1,case2,value2,other) 
			@df(yyMMdd) 日期格式化,如果不需要加入日期可以用@df('') -->
		<!--<table name="SQLTOY_DEVICE_ORDER" column="ORDER_ID"	generator="redis" signature="${psType}@case(${deviceType},PC,PC,NET,NT,OFFICE,OF,SOFTWARE,SF,OT)@day(yyMMdd)"
			related-columns="psType,deviceType" length="12" />-->
	</business-primary-key>

	<!-- 主子表的级联关系 update-cascade:delete 表示对存量数据进行删除操作,也可以写成:ENABLED=0(sql片段,置状态为无效),orderBy 支持级联时排序 -->
	<!--  常规情况下无需配置cascade,也不推荐,这里只是演示说明,不要被误导   -->
	<cascade>
		<!-- <table  name="SAG_DICT_DETAIL"  update-cascade="delete" load="STATUS=1"  orderBy=""/> -->
	</cascade>

	<!-- 数据类型对应关系 
	    native-types表示特定数据库返回的字段类型; 
	    jdbc-type:表示对应jdbc标准的类型(见:java.sql.Types),主要用于vo @Column注解中,设置其类型,方便操作数据库插入或修改时设置类型;
		java-type:表示对应java对象的属性类型(非java.lang的需要将包名写完整便于import) 
		import-types: 可以自行定义需要引入的类型,多个用逗号分隔
		-->
	<type-mapping>
		<!-- 保留1个范例,一般无需配置 -->
		<sql-type native-types="NUMBER,DECIMAL,NUMERIC"	precision="1..8" scale="0" jdbc-type="INTEGER" java-type="Integer" />
		<!-- 增加雪花算法的演示 -->
		<sql-type native-types="BIGINT" jdbc-type="BIGINT" java-type="java.math.BigInteger" />
<!-- 泛型注意xml转义符号,table-field指定具体表和字段; jdbc-type 可以直接填数字(jdbc.Types没有明显区分的类型)-->
		<sql-type table-field="sqltoy_jsontype_showcae.staff_set" native-types="json" jdbc-type="1021" java-type="List&lt;StaffInfoVO&gt;" import-types="com.sqltoy.quickstart.vo.StaffInfoVO" />
	</type-mapping>
</quickvo>
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.

简介

sagacity-sqltoy 配套项目,用于从数据库生成POJO! 展开 收起
Java 等 3 种语言
Apache-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/sagacity/sagacity-quickvo.git
git@gitee.com:sagacity/sagacity-quickvo.git
sagacity
sagacity-quickvo
sagacity-quickvo
master

搜索帮助