MyBatis-Plus-Generator-UI 项目配置与使用深度解析

项目配置存储优化

在MyBatis-Plus-Generator-UI项目中，默认配置文件的存储位置存在一个常见痛点：当项目移动或更换开发环境时，用户配置容易丢失。这是因为默认实现将配置文件存储在系统用户目录下（user.home）。

通过修改UserConfigStore.java类中的afterPropertiesSet方法，我们可以将配置存储位置调整为项目根目录。这一改动不仅解决了配置丢失问题，还使得项目配置能够随代码库一起版本控制，便于团队协作开发。

public void afterPropertiesSet() throws Exception {
    // 原实现：存储在系统用户目录
    // this.storeDir = PathUtil.joinPath(System.getProperty("user.home"), CONFIG_HOME, generatorConfig.getBasePackage());
    // this.userConfigPath = this.storeDir + File.separator + "user-config.json";
    
    // 修改后：存储在项目根目录
    this.storeDir = PathUtil.joinPath(System.getProperty("user.dir"));
    this.userConfigPath = this.storeDir + File.separator + "user-config.json";
}

模板管理最佳实践

模板管理是代码生成器的核心功能之一。针对不同项目需求，建议采用以下模板管理策略：

1. 分层管理：将当前项目使用的模板放在最外层目录，确保直接可用
2. 分类归档：为不常用的模板创建专用文件夹进行分类存放
3. 保留原始：始终保持原始模板的完整性，作为基准参考

这种管理方式既保证了常用模板的便捷访问，又维护了模板库的完整性和可追溯性。

配置持久化机制

项目的配置保存机制遵循以下流程：

1. 启动项目并通过浏览器访问UI界面
2. 在界面完成各项配置设置
3. 执行保存操作后，配置将持久化到user-config.json文件
4. 后续启动会自动加载已保存的配置

这一机制确保了开发环境的连续性，避免了重复配置的繁琐工作。

SQL生成类定制技巧

在DtoStrategyForm.vue组件中，handleMapperMethodInput方法控制着SQL语句生成的关键逻辑。开发者可以通过修改此方法实现：

1. 自定义生成SQL的条件语句
2. 调整返回实体类的命名规则
3. 指定生成代码的模块位置

这一灵活性使得生成的代码能够完美适配各种项目架构和编码规范。

分页功能通用化改造

原生的分页处理存在一定局限性。通过改造SqlGeneratorService类，我们可以实现更灵活的分页支持：

// 修改前：强制返回Page类型
// .returnType(returnType)

// 修改后：支持返回List或Page类型
String lastReturnType = returnType.replaceFirst("List","Page");
JavaClassMethodInfo methodInfo = JavaClassMethodInfo.builder()
    .classRef(daoClassRef)
    .methodName(config.getMapperMethod())
    .returnType(lastReturnType)
    .importJavaTypes(imports)
    .params(methodParams)
    .build();
javaClassParser.addMethod2Interface(methodInfo);

这一改进使得生成的Mapper方法既可以支持分页查询，也可以用于普通列表查询，大大提高了代码的复用性。

常见问题修复

在AutoCompleteService类中存在一个参数顺序错误的Bug：

// Bug修复前
// doSearch(new File(mapperRootPath), DOT_XML, searchKey, hitNames);

// Bug修复后
doSearch(new File(mapperRootPath), searchKey, DOT_XML, hitNames);

正确的参数顺序确保了XML文件的搜索功能正常工作，这是使用代码生成功能的基础保障。

高效使用技巧

基于实际项目经验，总结出以下高效使用流程：

1. 初始化配置：选择一个测试表，生成空配置（不选择任何选项）
2. 设置项目路径：刷新并指定目标项目的绝对根路径
3. 生成SQL语句：在确认基础配置正确后，生成所需的SQL语句

这种分步操作方式避免了配置混乱，确保了生成代码的准确性和一致性。通过掌握这些技巧和优化点，开发者可以充分发挥MyBatis-Plus-Generator-UI的潜力，显著提升开发效率。