defaults.conf.rules.txt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qdbp-coding-core Show documentation
qdbp code generate tools
The newest version!
<> = parser.txt
<> = publisher.txt

## 输出文件夹, 如果未配置则输出至配置文件同级目录的code文件夹下
output.root.folder = /code-output/{config.project}/
 
## SQL文件的路径, 如果为空, 则取配置文件同名的.sql文件
## 如配置文件=_xxx_/order_manage.txt, 则SQL文件=_xxx_/order_manage.sql
# sql.file.path = 

## 以config开头的配置项可以在模板中引用, 如#{config.project}
## 但是这类配置项不支持占位符, 因为是最先导入的, 作为其他配置项的基础
## output.package.xxx配置项如果以.开头, 会自动加上com.gitee.qdbp和{config.project}
config.company = com.gitee.qdbp
# config.project = 

output.package.convert.model      = {property:output.package.model}
output.package.convert.handler    = {property:output.package.service.handler}

output.file.convert.model         = {convert.model.capitalizeName}.java
output.file.convert.handler       = {convert.handler.capitalizeName}.java
output.file.enum                  = {enum.capitalizeName}.java
output.file.model.bean            = {table.capitalizeName}Bean.java
output.file.model.where           = {table.capitalizeName}Where.java
output.file.model.update          = {table.capitalizeName}Update.java
output.file.dao                   = I{table.capitalizeName}BasicDao.java
output.file.mapper                = {table.capitalizeName}BasicMapper.xml
output.file.service.basic         = {table.capitalizeName}Basic.java
output.file.service.api.queryer   = I{table.capitalizeName}Queryer.java
output.file.service.impl.queryer  = {table.capitalizeName}Queryer.java
output.file.service.api.executor  = I{table.capitalizeName}Executor.java
output.file.service.impl.executor = {table.capitalizeName}Executor.java

## 物理主键生成方式(AUTO_INCREMENT或静态方法或SERVICE)
## SERVICE很难做成配置, 只能设置一个标志, 在生成代码时判断
common.primary.key.generator.integer = AUTO_INCREMENT
# common.primary.key.generator.string = com.gitee.qdbp.tools.utils.RandomTools.generateUuid
common.primary.key.generator.string = SERVICE
common.primary.key.generator.service.imports.list.1 = org.springframework.beans.factory.annotation.Autowired
common.primary.key.generator.service.imports.list.2 = com.gitee.qdbp.general.common.api.sequence.service.ILocalSequenceGenerator

## 通用枚举
common.enums.Gender = com.gitee.qdbp.base.enums.Gender
## 通用静态赋值字段
# common.constant.field.version = com.gitee.qdbp.core.system.enums.Keys.version

## 列表查询接口的返回结果是什么
# list.result.class = java.util.List
list.result.class = com.gitee.qdbp.able.jdbc.paging.PageList

## 工具类地址配置
utils.class.StringTools = com.gitee.qdbp.tools.utils.StringTools
utils.class.VerifyTools = com.gitee.qdbp.tools.utils.VerifyTools
utils.class.ConvertTools = com.gitee.qdbp.tools.utils.ConvertTools
utils.class.DateTools = com.gitee.qdbp.tools.utils.DateTools
utils.class.JsonTools = com.gitee.qdbp.tools.utils.JsonTools

## service.impl.tpl的注解
# imports.service.impl.executor.list.1 = org.springframework.stereotype.Service
config.annotation.service.impl.executor.list.1 = @Service

## 当前时间的数据库变量
config.current.time.sql.value = CURRENT_TIMESTAMP
## 随机数函数(8位随机数)(目前在逻辑删除采用随机数方式时用到)
## mysql: RAND() / oracle: DBMS_RANDOM.VALUE()
# config.random.sql.value = UUID()
config.random.sql.value = FLOOR(10000000 + RAND() * 89999999)

## 数据隔离(@DataIsolation): 指定字段名, 只要存在字段就会加上注解; 或者字段注释中含有指定的正则表达式, 则加注解.
data.isolation.class = com.gitee.qdbp.base.annotation.DataIsolation
# data.isolation.field = tenant_code|dept_code
data.isolation.comment = \(di\)
## 操作轨迹(@OperateTraces): 全局开启, 通过在主键的注释加(op=no)取消; 或全局禁用, 通过在主键的注释加(op)开启.
operate.traces.class = com.gitee.qdbp.base.annotation.OperateTraces
operate.traces.enable = true
## yes/on/true/1; no/off/false/0
operate.traces.comment = \(op(?:=(\w+))?\)

## 枚举类转换器
enum.type.handler = org.apache.ibatis.type.EnumOrdinalTypeHandler
# data.state.handler = org.apache.ibatis.type.EnumOrdinalTypeHandler
## V3.1.0+
# data.state.handler = com.gitee.qdbp.base.orm.mybatis.converter.EnumOrdinalHandler
## V3.3.0+
data.state.handler = com.gitee.qdbp.base.orm.mybatis.converter.DataStateTypeHandler

## 类型转换

## 通用转换规则
## (options)默认类型为map,默认类名为表名加Options
## (options:list:ResourceOptions)全配置
type.convert.options = \(options(?:\:([\w\<\>\[\]]+))?\)
# type.convert.options.field = options
type.convert.options.generate = both
## 如果注释中指定了model名称的话, model的类名和handler的类名部分会被覆盖(package部分不变)
type.convert.options.model = {table.capitalizeName}Options
type.convert.options.handler = {table.capitalizeName}OptionsHandler
## 是否在Bean中生成getOptions(boolean force)方法
type.convert.options.force.getter = true

## 专用转换规则: JsonObject
type.convert.json = \(json\)
## 如果指定了class, 那么handler一定要配置, generate/type/model/field都不会生效了
type.convert.json.class = java.util.Map
type.convert.json.handler = com.gitee.qdbp.base.orm.mybatis.converter.JsonTypeHandler

## 专用转换规则: ResourceOptions
# type.convert.ResourceOptions = \(ResourceOptions\)
## 是否生成对应的类, false|none=不生成, true|both=model+handler, 也可以指定只生成model或handler
# type.convert.ResourceOptions.generate = both
# type.convert.ResourceOptions.type = bean
# type.convert.ResourceOptions.model = com.gitee.qdbp.{config.project}.api.{table.packages}.model.ResourceOptions
# type.convert.ResourceOptions.handler = com.gitee.qdbp.{config.project}.biz.{table.packages}.basic.ResourceOptionsHandler
## model/handler也可以只配置类名, 包名将采用output.package.xxx配置项
# type.convert.ResourceOptions.model = ResourceOptions
# type.convert.ResourceOptions.handler = ResourceOptionsHandler
## 是否在Bean中生成getOptions(boolean force)方法
# type.convert.ResourceOptions.force.getter = true

## 转换处理器对应的父类
type.convert.*.bean.handler.super  = com.gitee.qdbp.base.orm.mybatis.converter.JsonBeanTypeHandler
type.convert.*.list.handler.super  = com.gitee.qdbp.base.orm.mybatis.converter.JsonBeanListHandler
type.convert.*.array.handler.super = com.gitee.qdbp.base.orm.mybatis.converter.JsonBeanArrayHandler


## 逻辑删除: 如果某个表中存在数据状态字段(如data_state),就认定为逻辑删除
## 如果config.logically.delete.field(data_state)字段类型是字符串,则是随机数模式,创建时插入0,逻辑删除时更新为随机数, 解决唯一索引问题
## 随机数模式一定要配置common.enums.DataState,因为这个枚举是不会出现在sql注释中的
# config.logically.delete.field = data_state
# config.logically.delete.enum = DataState
# config.logically.delete.on = NORMAL
# config.logically.delete.off = DELETED


## import类配置(基础配置从100开始,低于100的留给业务配置用)
## imports.xxx.xx.list.n = 
# ModelBean
imports.model.bean.list.101 = java.io.Serializable
imports.model.bean.list.102 = java.util.List
imports.model.bean.list.103 = java.util.ArrayList
imports.model.bean.list.104 = com.gitee.qdbp.able.jdbc.paging.PartList
# ModelWhere
imports.model.where.list.101 = java.util.List
imports.model.where.list.102 = java.util.ArrayList
imports.model.where.list.103 = java.util.Arrays
# DAO
imports.dao.list.101 = java.util.List
imports.dao.list.102 = com.gitee.qdbp.able.jdbc.paging.Paging
imports.dao.list.103 = com.gitee.qdbp.base.model.condition.Where
imports.dao.list.104 = com.gitee.qdbp.base.model.condition.OrderWhere
# ServiceBasic
imports.service.basic.list.101 = java.util.List
imports.service.basic.list.102 = org.slf4j.Logger
imports.service.basic.list.103 = org.slf4j.LoggerFactory
imports.service.basic.list.104 = org.springframework.beans.factory.annotation.Autowired
imports.service.basic.list.105 = org.springframework.dao.DuplicateKeyException
imports.service.basic.list.106 = org.springframework.stereotype.Service
imports.service.basic.list.108 = com.gitee.qdbp.able.result.ResultCode
imports.service.basic.list.109 = com.gitee.qdbp.able.exception.ServiceException
imports.service.basic.list.111 = com.gitee.qdbp.able.jdbc.ordering.OrderPaging
imports.service.basic.list.112 = com.gitee.qdbp.base.model.condition.Where
imports.service.basic.list.113 = com.gitee.qdbp.base.model.condition.OrderWhere
imports.service.basic.list.114 = com.gitee.qdbp.tools.utils.VerifyTools
imports.service.basic.list.115 = com.gitee.qdbp.tools.utils.JsonTools
# QueryerApi
imports.service.api.queryer.list.102 = com.gitee.qdbp.able.exception.ServiceException
imports.service.api.queryer.list.103 = com.gitee.qdbp.able.jdbc.ordering.OrderPaging
# QueryerImpl
imports.service.impl.queryer.list.101 = org.springframework.beans.factory.annotation.Autowired
imports.service.impl.queryer.list.102 = org.springframework.stereotype.Service
imports.service.impl.queryer.list.103 = org.springframework.transaction.annotation.Transactional
imports.service.impl.queryer.list.104 = com.gitee.qdbp.able.exception.ServiceException
imports.service.impl.queryer.list.105 = com.gitee.qdbp.able.jdbc.ordering.OrderPaging
# ExecutorApi
imports.service.api.executor.list.101 = java.util.List
imports.service.api.executor.list.102 = com.gitee.qdbp.able.exception.ServiceException
imports.service.api.executor.list.103 = com.gitee.qdbp.base.system.model.IAccount
# ExecutorImpl
imports.service.impl.executor.list.102 = java.util.Arrays
imports.service.impl.executor.list.103 = java.util.List
imports.service.impl.executor.list.104 = org.slf4j.Logger
imports.service.impl.executor.list.105 = org.slf4j.LoggerFactory
imports.service.impl.executor.list.106 = org.springframework.beans.factory.annotation.Autowired
imports.service.impl.executor.list.107 = org.springframework.stereotype.Service
imports.service.impl.executor.list.108 = org.springframework.transaction.annotation.Transactional
imports.service.impl.executor.list.109 = org.springframework.transaction.annotation.Propagation
imports.service.impl.executor.list.110 = com.gitee.qdbp.able.result.ResultCode
imports.service.impl.executor.list.111 = com.gitee.qdbp.able.exception.ServiceException
imports.service.impl.executor.list.112 = com.gitee.qdbp.base.system.model.IAccount
imports.service.impl.executor.list.117 = com.gitee.qdbp.tools.utils.VerifyTools
# ConvertModel
imports.convert.model.list.101 = com.gitee.qdbp.able.model.reusable.ExtraData