com.kg.component.generator.config.PackageConfig Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2021, baomidou ([email protected]).
*
* 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
*
* https://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.
*/
package com.kg.component.generator.config;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import org.jetbrains.annotations.NotNull;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
/**
* 包相关的配置项
*
* @author YangHu, tangguo, hubin
* @since 2016-08-30
*/
public class PackageConfig {
private PackageConfig() {
}
/**
* 父包名。如果为空，将下面子包名必须写全部， 否则就只需写子包名
*/
private String parent = "com.baomidou";
/**
* 父包模块名
*/
private String moduleName = "";
/**
* Entity包名
*/
private String entity = "entity";
/**
* DTO包名
*/
private String dto = "dto";
private String dtoconvert = "dto.convert";
/**
* Excel包名
*/
private String excelConstant = "excels";
private String excelOut = "excels";
/**
* Service包名
*/
private String service = "service";
/**
* Service Impl包名
*/
private String serviceImpl = "service.impl";
/**
* Mapper包名
*/
private String mapper = "mapper";
/**
* Mapper XML包名
*/
private String xml = "mapper.xml";
/**
* Controller包名
*/
private String controller = "controller";
/**
* 路径配置信息
*/
private Map pathInfo;
/**
* 包配置信息
*
* @since 3.5.0
*/
private final Map packageInfo = new HashMap<>();
/**
* 父包名
*/
@NotNull
public String getParent() {
if (StringUtils.isNotBlank(moduleName)) {
return parent + StringPool.DOT + moduleName;
}
return parent;
}
/**
* 父包名 - 根路径
*/
public String getBaseParent() {
return parent;
}
/**
* 连接父子包名
*
* @param subPackage 子包名
* @return 连接后的包名
*/
@NotNull
public String joinPackage(String subPackage) {
String parent = getParent();
return StringUtils.isBlank(parent) ? subPackage : (parent + StringPool.DOT + subPackage);
}
/**
* 获取包配置信息
*
* @return 包配置信息
* @since 3.5.0
*/
@NotNull
public Map getPackageInfo() {
if (packageInfo.isEmpty()) {
packageInfo.put(ConstVal.MODULE_NAME, this.getModuleName());
packageInfo.put(ConstVal.ENTITY, this.joinPackage(this.getEntity()));
packageInfo.put(ConstVal.DTO, this.joinPackage(this.getDTO()));
packageInfo.put(ConstVal.DTOCONVERT, this.joinPackage(this.getDtoconvert()));
packageInfo.put(ConstVal.EXCEL_CONSTANT, this.joinPackage(this.getExcelConstant()));
packageInfo.put(ConstVal.EXCEL_OUT, this.joinPackage(this.getExcelOut()));
packageInfo.put(ConstVal.MAPPER, this.joinPackage(this.getMapper()));
packageInfo.put(ConstVal.XML, this.joinPackage(this.getXml()));
packageInfo.put(ConstVal.SERVICE, this.joinPackage(this.getService()));
packageInfo.put(ConstVal.SERVICE_IMPL, this.joinPackage(this.getServiceImpl()));
packageInfo.put(ConstVal.CONTROLLER, this.joinPackage(this.getController()));
packageInfo.put(ConstVal.PARENT, this.getParent());
}
return Collections.unmodifiableMap(this.packageInfo);
}
/**
* 获取包配置信息
*
* @param module 模块
* @return 配置信息
* @since 3.5.0
*/
public String getPackageInfo(String module) {
return getPackageInfo().get(module);
}
public String getModuleName() {
return moduleName;
}
public String getEntity() {
return entity;
}
public String getDTO() {
return dto;
}
public String getDtoconvert() {
return dtoconvert;
}
public String getExcelConstant() {
return excelConstant;
}
public String getExcelOut() {
return excelOut;
}
public String getService() {
return service;
}
public String getServiceImpl() {
return serviceImpl;
}
public String getMapper() {
return mapper;
}
public String getXml() {
return xml;
}
public String getController() {
return controller;
}
public Map getPathInfo() {
return pathInfo;
}
/**
* 构建者
*
* @author nieqiurong
* @since 3.5.0
*/
public static class Builder implements IConfigBuilder {
private final PackageConfig packageConfig;
public Builder() {
this.packageConfig = new PackageConfig();
}
public Builder(@NotNull String parent, @NotNull String moduleName) {
this();
this.packageConfig.parent = parent;
this.packageConfig.moduleName = moduleName;
}
/**
* 指定父包名
*
* @param parent 父包名
* @return this
*/
public Builder parent(@NotNull String parent) {
this.packageConfig.parent = parent;
return this;
}
/**
* 指定模块名称
*
* @param moduleName 模块名
* @return this
*/
public Builder moduleName(@NotNull String moduleName) {
this.packageConfig.moduleName = moduleName;
return this;
}
/**
* 指定实体包名
*
* @param entity 实体包名
* @return this
*/
public Builder entity(@NotNull String entity) {
this.packageConfig.entity = entity;
return this;
}
/**
* 指定DTO包名
*
* @param dto DTO包名
* @return this
*/
public Builder dto(@NotNull String dto) {
this.packageConfig.dto = dto;
return this;
}
/**
* 指定Convert包名
*
* @param dtoconvert Convert包名
* @return this
*/
public Builder dtoconvert(@NotNull String dtoconvert) {
this.packageConfig.dtoconvert = dtoconvert;
return this;
}
/**
* 指定Excels包名
*
* @param excelConstant Excels包名
* @return this
*/
public Builder excelConstant(@NotNull String excelConstant) {
this.packageConfig.excelConstant = excelConstant;
return this;
}
/**
* 指定Excels包名
*
* @param excelOut Excels包名
* @return this
*/
public Builder excelOut(@NotNull String excelOut) {
this.packageConfig.excelOut = excelOut;
return this;
}
/**
* 指定service接口包名
*
* @param service service包名
* @return this
*/
public Builder service(@NotNull String service) {
this.packageConfig.service = service;
return this;
}
/**
* service实现类包名
*
* @param serviceImpl service实现类包名
* @return this
*/
public Builder serviceImpl(@NotNull String serviceImpl) {
this.packageConfig.serviceImpl = serviceImpl;
return this;
}
/**
* 指定mapper接口包名
*
* @param mapper mapper包名
* @return this
*/
public Builder mapper(@NotNull String mapper) {
this.packageConfig.mapper = mapper;
return this;
}
/**
* 指定xml包名
*
* @param xml xml包名
* @return this
*/
public Builder xml(@NotNull String xml) {
this.packageConfig.xml = xml;
return this;
}
/**
* 指定控制器包名
*
* @param controller 控制器包名
* @return this
*/
public Builder controller(@NotNull String controller) {
this.packageConfig.controller = controller;
return this;
}
/**
* 路径配置信息
*
* @param pathInfo 路径配置信息
* @return this
*/
public Builder pathInfo(@NotNull Map pathInfo) {
this.packageConfig.pathInfo = pathInfo;
return this;
}
/**
* 连接父子包名
*
* @param subPackage 子包名
* @return 连接后的包名
*/
@NotNull
public String joinPackage(@NotNull String subPackage) {
return this.packageConfig.joinPackage(subPackage);
}
/**
* 构建包配置对象
* 当指定{@link #parent(String)} 与 {@link #moduleName(String)}时,其他模块名字会加上这两个作为前缀
*
* 例如:
*
当设置 {@link #parent(String)},那么entity的配置为 {@link #getParent()}.{@link #getEntity()}
* 当设置 {@link #parent(String)}与{@link #moduleName(String)},那么entity的配置为 {@link #getParent()}.{@link #getModuleName()}.{@link #getEntity()}
*
*
* @return 包配置对象
*/
@Override
public PackageConfig build() {
return this.packageConfig;
}
}
}