# maven-quickvo-plugin

**Repository Path**: sagacity/maven-quickvo-plugin

## Basic Information

- **Project Name**: maven-quickvo-plugin
- **Description**: sqltoy quick maven插件
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 0
- **Created**: 2024-09-19
- **Last Updated**: 2025-08-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# maven-quickvo-plugin

#### 介绍
sqltoy quickvo maven插件，最新版本：1.0.7
* 在pom.xml 中加入quickvo的插件
* 在项目根路径下编写mvn-quickvo.bat,便于快速执行
```properties
mvn quickvo:quickvo
```

```xml
<plugins>
    <plugin>
        <groupId>com.sagframe</groupId>
        <artifactId>quickvo-maven-plugin</artifactId>
        <!--jdk1.8 版本用<version>1.0.7.jre8</version> -->
        <version>1.0.7</version>
        <configuration>
            <configFile>src/main/resources/quickvo.xml</configFile>
            <baseDir>${project.basedir}</baseDir>
        </configuration>
        <dependencies>
            <dependency>
                <groupId>com.mysql</groupId>
                <artifactId>mysql-connector-j</artifactId>
                <version>8.4.0</version>
            </dependency>
        </dependencies>
    </plugin>
</plugins>
```
#### quickvo.xml配置
* 请参见 https://gitee.com/sagacity/sqltoy-quickstart
* 在src/resources下面创建quickvo.xml
* 参照下面的例子：注意根据项目实际情况决定是否要严格分entity和dto(vo)两层

```xml
<?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">
	<!-- 下面两行是强调数据库的关键属性不一定要用 file="db.properties" 方式来引入 -->
	<!--<property name="jdbc.username" value="mydb" />-->
	<!--<property name="jdbc.password" value="mydbPassword" />-->
	<!-- db配置文件,也可以是application.yml 文件 -->
	<property file="src/resources/application.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" />
	<!-- 演示自定义类似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 配置不正确，没有完成隔离 -->
    <!-- 数据库用户对应单实例，可以不用配置schema和catalog -->
	<datasource name="strict" url="${db.url}" driver="${db.driver_class}" 
		schema="${db.schema}" catalog="${db.schema}" username="${db.username}" password="${db.password}" />
        <!-- 请灵活配置schema\catalog 属性，因为其会导致过滤错误，其内部逻辑：
           conn.getMetaData().getTables(catalog, schema, tableNamePattern, TABLE)
            填错了schema\catalog 必然错误
         <datasource name="strict" url="${db.url}" driver="${db.driver_class}" 
		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>
```