让代码更有生命：用注释点亮MyBatis代码之魂

2023-12-27 20:42:53

注释 MyBatis Generator 生成的代码：提升代码可读性和可维护性

在软件开发中，注释是至关重要的元素，有助于提升代码的可读性、可维护性和协作性。MyBatis Generator 是一款方便快捷的工具，可以根据数据库表结构自动生成实体类和 Mapper 文件。然而，默认生成的代码中往往缺乏必要的注释，影响了代码的清晰度。本文将介绍如何为 MyBatis Generator 生成的代码添加注释，从而提高其质量。

实体类注释

在实体类中，我们可以使用 /** 和 */ 来添加多行注释，类、属性和方法的用途。例如：

/**
 * 用户实体类
 */
public class User {

    /**
     * 用户ID
     */
    private Long id;

    /**
     * 用户名
     */
    private String username;

    /**
     * 密码
     */
    private String password;

    // 其他属性和方法
}

通过添加这些注释，我们清晰地了实体类的作用，避免了代码含义不明确的情况。

Mapper 文件注释

在 Mapper 文件中，可以使用  来添加注释。以下示例演示了如何注释一个查询语句：

<!-- 根据用户ID查询用户 -->
<select id="selectUserById" parameterType="long" resultType="com.example.demo.entity.User">
    SELECT * FROM user WHERE id = #{id}
</select>

通过添加注释，我们可以清楚地解释 SQL 语句的意图，方便其他开发者理解和维护代码。

记录变更历史

除了提高可读性之外，注释还可以记录代码的变更历史。在实体类中，可以使用 @deprecated 注解标记即将废弃的属性或方法，例如：

/**
 * @deprecated 将在下一个版本中废弃
 */
private String oldPassword;

在 Mapper 文件中，可以使用  注释标记即将废弃的 SQL 语句，例如：

<!-- @deprecated 将在下一个版本中废弃 -->
<select id="selectUserByName" parameterType="string" resultType="com.example.demo.entity.User">
    SELECT * FROM user WHERE username = #{username}
</select>