Spring Boot 统一设置Json数据返回风格(Java驼峰命名转下划线)

编写重写了WebMvcConfigurerAdapter的配置类

@Configuration
@EnableWebMvc
public class WebMvcConfig extends WebMvcConfigurerAdapter {

	/**
	 * 统一输出风格
	 * See {@link com.fasterxml.jackson.databind.PropertyNamingStrategy.SnakeCaseStrategy} for details.
	 * @param converters
	 */
	@Override
	public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
		for (int i = 0; i < converters.size(); i++) {
			if (converters.get(i) instanceof MappingJackson2HttpMessageConverter) {
				ObjectMapper objectMapper = new ObjectMapper();
				// 统一返回数据的输出风格
				objectMapper.setPropertyNamingStrategy(new PropertyNamingStrategy.SnakeCaseStrategy());
				objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
				objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
				objectMapper.setTimeZone(TimeZone.getTimeZone("GMT+8"));
				MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
				converter.setObjectMapper(objectMapper);
				converters.set(i, converter);
				break;
			}
		}// end for
	}
}

编写Controller

@GetMapping("/api/getUser")
	public Object getUser() {
		List<User> users = new ArrayList<User>();
		users.add(new User("1", "小京", "北京"));
		users.add(new User("2", "小海", "上海"));
		users.add(new User("1", "小广", null));
		return users;
	}

	@Data
	@AllArgsConstructor
	class User {
		private String id;

		private String userName;

		private String addr;
	}

查看返回结果

调用/api/getUser

[
    {
        "id": "1",
        "user_name": "小京",
        "addr": "北京"
    },
    {
        "id": "2",
        "user_name": "小海",
        "addr": "上海"
    },
    {
        "id": "1",
        "user_name": "小广"
    }
]

风格阐述

  • Java属性名称统一为如下规则
"userName" is translated to "user_name"
"UserName" is translated to "user_name"
"USER_NAME" is translated to "user_name"
"user_name" is translated to "user_name" (unchanged)
"user" is translated to "user" (unchanged)
"User" is translated to "user"
"USER" is translated to "user"
"_user" is translated to "user"
"_User" is translated to "user"
"__user" is translated to "_user" (the first of two underscores was removed)
"user__name" is translated to "user__name" (unchanged, with two underscores)  
  • 空字段不进行返回。如:测试数据中的小广,没有地址信息,则不返回’addr’字段
  • 5
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
Spring Boot开发中,我们经常需要将JSON对象换为Java对象或反之亦然。但是,在JSONJava对象之间换的过程中,往往会遇到下划线驼峰命名风格的差异问题。这个时候,我们可以使用Spring Boot自带的Jackson库进行换。下面我将详细介绍如何在Spring Boot中使用Jackson库进行下划线驼峰格式的换。 1. 下划线换成驼峰Spring Boot中,使用Jackson库进行下划线驼峰命名格式的换,需要在配置文件中进行配置,首先我们需要在application.yaml配置文件中添加以下内容: ```yaml # 进行下划线驼峰 spring: jackson: property-naming-strategy: com.fasterxml.jackson.databind.PropertyNamingStrategy$SnakeCaseStrategy ``` 添加这段配置代码后,就可以实现下划线驼峰。在进行Java对象与JSON字符串之间的换时,JSON字符串的下划线将会自动换为Java对象的驼峰命名格式,例如,原本`user_name`的JSON字段在Java对象中将会变成`userName`。 2. 驼峰换成下划线 在进行Java对象与JSON字符串之间的换时,我们也可以将Java对象中的驼峰命名格式换为JSON字符串中的下划线。要实现这个功能,我们需要在配置文件中加入以下代码: ```yaml # 进行驼峰下划线 spring: jackson: property-naming-strategy: com.fasterxml.jackson.databind.PropertyNamingStrategy$SNAKE_CASE ``` 这时候,在进行Java对象与JSON字符串之间的换时,Java对象中的驼峰命名格式就会被自动换成JSON字符串中的下划线格式,例如,Java对象中的`userName`字段会自动被换成JSON字符串中的`user_name`。 总结: 在Spring Boot中,使用Jackson库进行下划线驼峰命名格式的换,只需要在application.yaml配置文件中添加一段内容即可。设置`com.fasterxml.jackson.databind.PropertyNamingStrategy$SnakeCaseStrategy`可以将下划线换成Java对象的驼峰命名格式,而将`com.fasterxml.jackson.databind.PropertyNamingStrategy$SNAKE_CASE`设置为属性命名策略,则可以将Java对象中的驼峰命名格式自动换成JSON字符串中的下划线格式。这样的配置可以很方便地适应不同的数据接口和Java对象。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值