当前位置：首页 > news >正文

SpringBoot13-小细节

news 2025/10/8 5:40:59

一、开启Mybatis驼峰命名和下划线命名的转换

在 MyBatis 中，想让数据库字段的下划线命名自动映射到 Java 实体的驼峰命名（例如 user_name → userName），只需要在配置里 开启自动下划线转驼峰 功能即可。

1. 在 `application.yml` 或 `application.properties` 中配置（推荐）

如果你用的是 Spring Boot + MyBatis，直接在配置文件里加上：

`application.yml`

mybatis:configuration:map-underscore-to-camel-case: true

`application.properties`

mybatis.configuration.map-underscore-to-camel-case=true

注意：如果你用的是 MyBatis-Plus，配置同样有效，也可以用它自己的配置：
mybatis-plus:configuration:map-underscore-to-camel-case: true

2. 如果是纯 MyBatis（XML 配置）

在 MyBatis 的 mybatis-config.xml 里设置：

<configuration><settings><!-- 开启自动下划线转驼峰 --><setting name="mapUnderscoreToCamelCase" value="true"/></settings>
</configuration>

3. 注意事项

数据库字段名要用 小写+下划线 格式，如：user_id、create_time；
Java 实体用驼峰：userId、createTime。
如果字段名和属性名完全不匹配（比如列叫 USERID 而属性是 userId），就算开启了也不会自动映射，需要用 @Result 或 resultMap 指定。
如果你用了 MyBatis Generator 或 MyBatis-Plus 自动生成代码，通常生成的实体已经和表字段对应好了，就不一定需要这个设置。

总结

在 Spring Boot 中最简单的方式：
mybatis:configuration:map-underscore-to-camel-case: true
就能让 user_name → userName 自动映射。
如果是传统 MyBatis 项目，就在 mybatis-config.xml 里加 <setting name="mapUnderscoreToCamelCase" value="true"/>。

补充：@Result 和 resultMap

在 MyBatis 中，默认的自动映射规则是：

列名 ↔ Java 属性名 按下划线转驼峰规则自动匹配（如果在配置里打开 mapUnderscoreToCamelCase=true）。
如果列名和属性名完全不对应（既不相同，也无法通过下划线转驼峰得到），就无法自动映射，必须手工指定。

下面用一个具体例子演示。

❌ 自动映射失败示例

假设数据库表：

CREATE TABLE t_user (USERID    VARCHAR(32),USER_NAME VARCHAR(50)
);

Java 实体：

public class User {private String userId;   // 注意：列名是 USERIDprivate String username; // 注意：列名是 USER_NAME// getter / setter 省略
}

配置里已经开启：

<settings><setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>

MyBatis 查询：

<select id="selectAll" resultType="User">SELECT USERID, USER_NAME FROM t_user
</select>

结果：

userId 可以映射到 USERID（因为大小写不敏感，MyBatis 默认支持），✅
但 username 无法自动映射，因为列是 USER_NAME，驼峰转换后会是 userName，而实体叫 username（少了驼峰的大写 N）。

自动映射规则只负责把 USER_NAME → userName，不会再去匹配 username。

✅ 正确做法：用 `@Results` / `resultMap`

方式一：注解版

@Mapper
public interface UserMapper {@Select("SELECT USERID, USER_NAME FROM t_user")@Results(id = "userMap", value = {@Result(column = "USERID", property = "userId"),@Result(column = "USER_NAME", property = "username")})List<User> selectAll();
}

方式二：XML 配置版

<resultMap id="userMap" type="User"><result column="USERID" property="userId"/><result column="USER_NAME" property="username"/>
</resultMap><select id="selectAll" resultMap="userMap">SELECT USERID, USER_NAME FROM t_user
</select>

总结

MyBatis 自动映射只能处理：
- 列名与属性名相同（忽略大小写），或
- 列名下划线转驼峰后与属性名相同。
如果列名和属性名完全对不上（USERID → userId 能自动，但 USER_NAME → username 就不行），必须用 @Result / <resultMap> 明确指定。
因此当遇到命名规则不一致的老库或第三方表时，一定要写 resultMap 或注解映射。

二、控制台打印出实际执行的 SQL 语句及参数

在 Spring Boot + MyBatis 项目中，想让控制台打印出实际执行的 SQL 语句及参数，可以用以下几种常见配置方式：

最推荐：application.yml 配置

mybatis:configuration:log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

这样启动项目后，控制台会直接输出完整 SQL，包括参数值和执行时间。

三、@JsonIgnore讲解

@JsonIgnore 是 Jackson（Spring Boot 默认使用的 JSON 序列化/反序列化库）提供的注解，用来在对象与 JSON 之间进行转换时忽略某个字段。

2-1. 基本作用

序列化时忽略
把对象转成 JSON 时，标注了 @JsonIgnore 的字段 不会出现在返回的 JSON 中。
反序列化时忽略
把 JSON 转成对象时，标注了 @JsonIgnore 的字段 不会从 JSON 中读取值并赋给对象。

示例代码

import com.fasterxml.jackson.annotation.JsonIgnore;public class User {private String username;@JsonIgnoreprivate String password;  // 不希望返回给前端private String email;// getters and setters
}

控制器示例

@RestController
@RequestMapping("/user")
public class UserController {@GetMappingpublic User getUser() {User u = new User();u.setUsername("Tom");u.setPassword("123456");u.setEmail("tom@example.com");return u;}
}

返回结果

{"username": "Tom","email": "tom@example.com"
}

password 字段被自动忽略了。

2-2. 常见使用场景

场景	说明
隐藏敏感信息	比如密码、身份证号、token，不希望返回给前端。
避免循环引用	有双向关联时，防止无限递归序列化（但更推荐用 `@JsonManagedReference` / `@JsonBackReference`）。
只在内部使用	某些内部计算字段只在后台用，不需要暴露给外部接口。

2-3. 与其他注解的区别

注解	作用
`@JsonIgnore`	永远忽略此字段，序列化 & 反序列化都跳过。
`@JsonProperty`	自定义 JSON 字段名称，或者强制包含某个字段。
`@JsonIgnoreProperties`	批量忽略指定的字段，作用在类上。
`@JsonInclude`	控制字段为空时是否序列化（例如只序列化非 null 的字段）。

对比 `@JsonIgnoreProperties`

@JsonIgnoreProperties({"password","id"})
public class User { ... }

一次性忽略多个属性，适合类上统一处理。

⚠️ 注意事项

@JsonIgnore 只对 Jackson 有效（Spring Boot 默认是 Jackson），如果换成 Gson/Fastjson 不会生效。
如果一个字段加了 @JsonIgnore，反序列化也不会给它赋值。如果你只想“序列化时忽略，反序列化时接收”，用@JsonProperty：
```
@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
```
例如：
```
@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
private String password; 
```
这样：前端可以传 password，但返回 JSON 时不显示。