当前位置:首页 > 技术 > 正文内容

通过代码生成器自动化构建数据层与接口层

访客 技术 2026年6月10日 1

为了提升开发效率并告别重复的 CRUD(增删改查)代码编写,我们可以利用 Java 反射机制构建一套轻量级的代码生成方案。该方案仅需定义实体类,即可自动生成 MyBatis Mapper XML、Dao 接口、Service 层逻辑、Controller 层代码以及基础的 DDL 建表语句。

核心设计思路

通过读取实体类(Entity)的字段类型、注解信息及类注释,利用字符串构建器(StringBuilder)生成对应格式的 Java 源文件和 XML 映射文件,并直接落盘到指定项目目录中。

自动化 Mapper 映射生成

以下代码示例展示了如何解析类结构并生成 MyBatis 映射文件:


public class MapperCodeGen {
    public static String buildMapperXml(Class<?> entityClass) {
        StringBuilder builder = new StringBuilder();
        builder.append("<mapper namespace=\"").append(entityClass.getName()).append("\">\n");
        // 生成 ResultMap 和基础 SQL 片段
        // ... (此处省略解析 Field 的逻辑)
        builder.append("  <insert id=\"save\"> INSERT INTO ... </insert>\n");
        builder.append("</mapper>");
        return builder.toString();
    }
}
    

构建 BaseDao 泛型基类

所有 Dao 层通过继承 BaseDao<T> 来复用基础 CRUD 方法,利用 Spring 的 SqlSessionTemplate 执行 SQL:


public abstract class DataAccessBase<T> {
    @Autowired
    private SqlSessionTemplate sqlSession;

    public int insert(T record) {
        String statement = getNamespace() + ".save";
        return sqlSession.insert(statement, record);
    }
    
    // 获取当前类对应的 Mapper 命名空间
    protected abstract String getNamespace();
}
    

数据库 Schema 生成器

利用 Java 反射提取字段上的 Hibernate Validator 注解(如 @Length, @NotBlank),自动推断 SQL 数据类型及约束:


public class DdlGenerator {
    public static String generateTableSql(Class<?> clazz) {
        StringBuilder sb = new StringBuilder("CREATE TABLE " + toUnderline(clazz.getSimpleName()) + " (\n");
        for (Field field : clazz.getDeclaredFields()) {
            String type = field.getType().getSimpleName();
            String column = toUnderline(field.getName());
            sb.append("  ").append(column).append(" ").append(mapSqlType(type));
            // 解析注解添加非空约束
            if (field.isAnnotationPresent(NotBlank.class)) {
                sb.append(" NOT NULL");
            }
            sb.append(",\n");
        }
        return sb.append("  PRIMARY KEY (id)\n)").toString();
    }
}
    

开发建议与最佳实践

  • 增量生成保护:在生成文件前进行存在性检查(File.exists()),避免直接覆盖已编写的业务逻辑。
  • 元数据驱动:高度依赖实体类的注释(用于生成文档和数据库注释)及注解(用于生成字段约束),请务必保证实体类定义的完整性。
  • 扩展性:文中仅演示了基本的增删改查实现,复杂业务逻辑建议通过扩展 BaseService 并在生成的类中重写或调用 super 方法来实现。
  • 工程路径:生成器会自动定位 src/main/javasrc/main/resources 目录,确保编译环境路径配置准确。
标签: JavaMyBatis

相关文章

Linux crontab 详解

1) crontab 是什么cron 是 Linux 的定时任务守护进程;crontab 是用来编辑/查看“按时间周期执行命令”的表(cron table)。常见两类:用户 crontab:每个用户一份(crontab -e 编辑)系统级 crontab / cron.d:可指定执行用户(/etc/crontab、/etc/cron.d/*)2) crontab 时间...

富文本里可以允许的 HTML 属性

一、所有标签默认允许的安全属性(极少)class        (可选)id           (通常建议禁用)title️ 注意:id 容易被滥用做锚点注入,很多系统直接禁用class 允许的话最好只允许固定前缀(如 editor-*)二、a 标签允许属性<a href="" t...

Mac 安装 Node.js 指南

方法一:通过官网安装包(最简单,适合初学者)如果你只是想快速安装并开始使用,这是最直接的方法。访问 Node.js 官网。页面会显示两个版本:LTS (Recommended For Most Users):长期支持版,最稳定。建议选这个。Current:最新特性版,包含最新功能但可能不够稳定。下载 .pkg 安装包并运行。按照安装向导点击“下一步”即可完成。方法二:使用 Homebrew 安装(...

Dom\HTML_NO_DEFAULT_NS 的副作用:自动加闭合标签

在使用Dom\HTMLDocument时,Dom\HTML_NO_DEFAULT_NS 将禁止在解析过程中设置元素的命名空间, 此设置是为了与DOMDocument向后兼容而存在的。当使用它时,已知的一个副作用就是:自动加闭合标签例如 </img> 为什么会这样?当你使用:Dom\HTML_NO_DEFAULT_NS文档会变成 无命名空间模式,此时内部更接近 XML...

Laravel 事件和监听器创建

在 Laravel 中,使用 Artisan 命令创建 Events(事件) 和 Listeners(监听器) 是非常高效的。你可以通过以下几种方式来实现:1. 手动创建单个 Event如果你只想创建一个事件类,可以使用 make:event 命令:Bashphp artisan make:event UserRegistered执行后,文件将生成在 app/Even...

自定义域名解析神器 dnsmasq

什么是 dnsmasq?dnsmasq 是一个轻量级、功能强大的网络服务工具,专为小型和中等规模网络设计。它是一个综合的网络基础设施解决方案[1]。dnsmasq 能做什么?功能说明应用场景DNS 转发与缓存将 DNS 查询转发到上游服务器(ISP、Google DNS 等),并在本地缓存结果加快 DNS 查询速度,减少外部 DNS 流量本地 DNS解析本地网络设备的主机名,无需编辑&n...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。