All Downloads are FREE. Search and download functionalities are using the official Maven repository.

cn.renlm.plugins.MyGeneratorConf Maven / Gradle / Ivy

There is a newer version: 2.8.8
Show newest version
/*
 * Copyright (c) 2020 Renlm
 * MyGenerator is licensed under Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 * 	http://license.coscl.org.cn/MulanPSL2
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */
package cn.renlm.plugins;

import java.io.Serializable;
import java.util.List;

import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
import com.thoughtworks.xstream.annotations.XStreamConverter;
import com.thoughtworks.xstream.annotations.XStreamImplicit;
import com.thoughtworks.xstream.converters.extended.ToAttributedValueConverter;

import cn.hutool.core.util.StrUtil;
import lombok.Data;

/**
 * 代码生成配置
 * 
 * @author RenLiMing(任黎明)
 *
 */
@Data
@XStreamAlias("config")
public class MyGeneratorConf {

	private static final String ENTITY_PLACEHOLDER = "{entityName}";

	private _TypeConvert typeConvert;

	@XStreamAlias("package")
	private _PackageConfig packageConfig;

	@XStreamAlias("strategy")
	private _StrategyConfig strategyConfig;
    
    /**
     * 开启 springdoc 模式(默认 false 与 swagger 不可同时使用,优先于 swagger)
     */
	@XStreamAsAttribute
    private boolean springdoc;
	
	/**
     * 开启 swagger 模式(默认 false 与 springdoc 不可同时使用)
     */
	@XStreamAsAttribute
    private boolean swagger;

	/**
	 * 实体类名称占位符转换
	 * 
	 * @param format
	 * @return
	 */
	public static final String entityPlaceholder(String format) {
		return StrUtil.replace(format, ENTITY_PLACEHOLDER, "%s");
	}

	/**
	 * 字段类型转换
	 */
	@Data
	public static final class _TypeConvert implements Serializable {

		private static final long serialVersionUID = 1L;

		@XStreamImplicit(itemFieldName = "javaSqlType")
		private List<_JavaSqlType> javaSqlTypes;

	}

	/**
	 * 字段类型映射
	 */
	@Data
	public static final class _JavaSqlType implements Serializable {

		private static final long serialVersionUID = 1L;

		/**
		 * java.sql.Types
		 */
		@XStreamAsAttribute
		private String name;

		/**
		 * com.baomidou.mybatisplus.generator.config.rules.DbColumnType.type
		 */
		@XStreamAsAttribute
		private String type;

		/**
		 * com.baomidou.mybatisplus.generator.config.rules.DbColumnType.pkg
		 */
		@XStreamAsAttribute
		private String pkg;

	}

	/**
	 * 包配置
	 */
	@Data
	public static final class _PackageConfig implements Serializable {

		private static final long serialVersionUID = 1L;

		/**
		 * Controller包名
		 */
		private String controller = "controller";

		/**
		 * Service Impl包名
		 */
		private String serviceImpl = "service.impl";

		/**
		 * Service包名
		 */
		private String service = "service";

		/**
		 * Entity包名
		 */
		private String entity = "entity";

		/**
		 * Mapper包名
		 */
		private String mapper = "mapper";

		/**
		 * Mapper XML包名
		 */
		private String xml = "mapper";

	}

	/**
	 * 策略配置
	 */
	@Data
	public static final class _StrategyConfig implements Serializable {

		private static final long serialVersionUID = 1L;

		private _Entity entity;

		private _Controller controller;

		private _Service service;

		private _Mapper mapper;

	}

	/**
	 * Entity 配置
	 */
	@Data
	public static final class _Entity implements Serializable {

		private static final long serialVersionUID = 1L;

		/**
		 * Entity 格式化名称
		 */
		private String formatFileName = "{entityName}";

		/**
		 * 禁用生成serialVersionUID
		 */
		private boolean disableSerialVersionUID;

		/**
		 * 是否生成实体时,生成字段注解(默认 true)
		 */
		private Boolean tableFieldAnnotationEnable = true;

		/**
		 * 乐观锁字段名称(数据库字段)
		 */
		private String versionColumnName;

		/**
		 * 逻辑删除字段名称(数据库字段)
		 */
		private String logicDeleteColumnName;

		/**
		 * 父类(全路径名称)
		 */
		private String superClass;

		/**
		 * 父类字段集
		 */
		private _SuperEntityColumns superEntityColumns;

	}

	@Data
	public static final class _SuperEntityColumns implements Serializable {

		private static final long serialVersionUID = 1L;

		@XStreamImplicit(itemFieldName = "column")
		private List<_Text> superEntityColumns;

	}

	@Data
	@XStreamConverter(value = ToAttributedValueConverter.class, strings = { "text" })
	public class _Text implements Serializable {

		private static final long serialVersionUID = 1L;

		private String text;

	}

	/**
	 * Controller 配置
	 */
	@Data
	public static final class _Controller implements Serializable {

		private static final long serialVersionUID = 1L;

		/**
		 * 是否生成Controller(默认否)
		 */
		@XStreamAlias("controller")
		private boolean enableController;

		/**
		 * 开启生成@RestController控制器(默认否)
		 */
		private boolean enableRestStyle;

		/**
		 * Controller 格式化名称
		 */
		private String formatFileName = "{entityName}Controller";

	}

	/**
	 * Service 配置
	 */
	@Data
	public static final class _Service implements Serializable {

		private static final long serialVersionUID = 1L;

		/**
		 * Service 格式化名称
		 */
		private String formatServiceFileName = "I{entityName}Service";

		/**
		 * Service Impl 格式化名称
		 */
		private String formatServiceImplFileName = "{entityName}ServiceImpl";

	}

	/**
	 * Mapper 配置
	 */
	@Data
	public static final class _Mapper implements Serializable {

		private static final long serialVersionUID = 1L;

		/**
		 * Mapper 格式化名称
		 */
		private String formatMapperFileName = "{entityName}Mapper";

		/**
		 * Mapper XML 格式化名称
		 */
		private String formatXmlFileName = "{entityName}Mapper";

	}

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy