总阅读量:次

⭐⭐⭐ Spring Boot 项目实战 ⭐⭐⭐ Spring Cloud 项目实战
《Dubbo 实现原理与源码解析 —— 精品合集》 《Netty 实现原理与源码解析 —— 精品合集》
《Spring 实现原理与源码解析 —— 精品合集》 《MyBatis 实现原理与源码解析 —— 精品合集》
《Spring MVC 实现原理与源码解析 —— 精品合集》 《数据库实体设计合集》
《Spring Boot 实现原理与源码解析 —— 精品合集》 《Java 面试题 + Java 学习指南》

摘要: 原创出处 juejin.cn/post/7489358088379187227 「Asthenian」欢迎转载，保留摘要，谢谢！

🙂🙂🙂关注微信公众号：【芋道源码】有福利：

  1. RocketMQ / MyCAT / Sharding-JDBC 所有源码分析文章列表
  2. RocketMQ / MyCAT / Sharding-JDBC 中文注释源码 GitHub 地址
  3. 您对于源码的疑问每条留言都将得到认真回复。甚至不知道如何读源码也可以请教噢。
  4. 新的源码解析文章实时收到通知。每周更新一篇左右。
  5. 认真的源码交流微信群。

面试官问我：你写代码会复用公共SQL么？

在一次Java后端开发的面试中，面试官问了我一个问题：“你在写代码时会复用公共SQL吗？如果会的话，能详细介绍一下你是如何实现的吗？”

这个问题让我眼前一亮，因为在实际项目中，SQL复用确实是一个非常实用且能提升代码质量的做法。

下面是我当时的回答，也借此机会整理成一篇博客，和大家分享一下我的经验。

我的回答：是的，我会复用公共SQL

我告诉面试官：“是的，我在开发中经常会复用公共SQL，尤其是在Java后端项目中。复用SQL不仅能减少代码重复，还能提高可维护性和一致性。我通常会结合具体的业务场景和框架特性来实现，比如使用MyBatis这样的ORM框架，或者通过自定义工具类来管理公共SQL片段。”

接着，面试官让我详细讲讲实现方式，我就从以下几个方面展开了说明。

实现方式一：MyBatis的<sql>标签

在Java后端开发中，我最常用的ORM框架是MyBatis。MyBatis提供了一个非常方便的特性——<sql>标签，可以用来定义可复用的SQL片段。

比如，在一个用户管理的模块中，经常需要查询用户的某些基础字段，像id、username、email等。如果每次都手写这些字段，既麻烦又容易出错，我就用<sql>标签把它们抽出来。

举个例子，我的UserMapper.xml可能会这样写：

<!-- 定义公共SQL片段 -->
<sql id="userBaseColumns">
    id, username, email, created_at, updated_at
</sql>

<!-- 查询用户列表 -->
<select id="selectUserList" resultType="User">
    SELECT <include refid="userBaseColumns"/>
    FROM users 
    WHERE status = #{status}
</select>

<!-- 查询单个用户 -->
<select id="selectUserById" resultType="User">
    SELECT <include refid="userBaseColumns"/>
    FROM users 
    WHERE id = #{id}
</select>

通过<include>标签，我可以在多个SQL语句中复用userBaseColumns这个片段。这样，如果以后需要调整查询字段（比如新增phone字段），只需要改动<sql>定义的地方，所有引用它的查询都会自动更新，省时省力。

实现方式二：动态SQL与Java代码封装

有时候，SQL的复用不仅仅是字段列表，还可能是复杂的条件逻辑。比如，很多业务场景下会有分页查询的需求，LIMIT和OFFSET是固定的模式。我会结合MyBatis的动态SQL和Java代码来实现复用。

比如，我会写一个通用的分页工具类：

public class PageHelper {
    public static String appendPageSql(String sql, int pageNum, int pageSize) {
        int offset = (pageNum - 1) * pageSize;
        return sql + " LIMIT " + pageSize + " OFFSET " + offset;
    }
}

然后在Mapper接口中调用：

@SelectProvider(type = UserSqlProvider.class, method = "getUserListSql")
List<User> getUserList(int status, int pageNum, int pageSize);

class UserSqlProvider {
    public String getUserListSql(int status, int pageNum, int pageSize) {
        String sql = "SELECT id, username, email FROM users WHERE status = #{status}";
        return PageHelper.appendPageSql(sql, pageNum, pageSize);
    }
}

这样，任何需要分页的查询都可以复用PageHelper，只需要传入页码和每页大小即可。这种方式在Java层实现了SQL的动态拼接，既灵活又可控。

实现方式三：常量类管理SQL片段

如果项目中不完全依赖MyBatis，或者有些SQL是直接通过JDBC执行的，我会用Java的常量类来管理公共SQL片段。比如：

public class SqlConstants {
    public static final String USER_BASE_COLUMNS = "id, username, email, created_at, updated_at";
    public static final String USER_TABLE = "users";
    public static final String SELECT_USER_BY_ID = 
        "SELECT " + USER_BASE_COLUMNS + " FROM " + USER_TABLE + " WHERE id = ?";
}

然后在DAO层使用：

public User getUserById(Long id) {
    String sql = SqlConstants.SELECT_USER_BY_ID;
    return jdbcTemplate.queryForObject(sql, new Object[]{id}, new UserRowMapper());
}

这种方式的好处是简单直观，适合小型项目或者需要快速开发的场景。不过缺点是缺乏动态性，如果SQL逻辑复杂，维护起来会稍显麻烦。

为什么复用SQL很重要？

我还跟面试官补充了一下为什么要这样做。复用公共SQL有几个明显的好处：

  • 减少重复代码： 避免在多个地方写相同的SQL片段，符合DRY（Don't Repeat Yourself）原则。
  • 提高可维护性： 改动一处，全局生效，降低出错风险。
  • 提升一致性： 比如字段顺序、命名规范都能统一，避免开发人员各自发挥。

总结

最后，我总结道：“在Java后端开发中，复用公共SQL是一个很实用的习惯。我会根据项目规模和需求选择合适的方式，小项目可能用常量类就够了，大项目则更倾向于MyBatis的<sql>标签或者动态SQL结合工具类。关键是要让代码既高效又易于维护。”

面试官听完点了点头，似乎对我的回答还挺满意。这次经历也让我更深刻地认识到，技术细节的积累和清晰的表达在面试中都很重要。希望这篇博客也能帮到正在准备面试的你！

文章目录
  1. 1. 面试官问我：你写代码会复用公共SQL么？
  2. 2. 我的回答：是的，我会复用公共SQL
  3. 3. 实现方式一：MyBatis的<sql>标签
  4. 4. 实现方式二：动态SQL与Java代码封装
  5. 5. 实现方式三：常量类管理SQL片段
  6. 6. 为什么复用SQL很重要？
  7. 7. 总结