Springboot整合swagger Boolean类型字段以is开头 字段不显示问题

最新推荐文章于 2025-07-07 18:42:17 发布
最新推荐文章于 2025-07-07 18:42:17 发布
阅读量1.3k 收藏 1
点赞数
CC 4.0 BY-SA版权
文章标签： java swagger2 spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/taotaozt/article/details/122194996
在Springboot应用中使用swagger进行API文档生成时遇到一个问题，Boolean类型的字段如果以is开头，在生成的文档中字段名会缺失is前缀，且其描述信息未正确显示。例如`needActivation`和`isWriteOffImmediately`字段。总结建议避免使用以is开头的Boolean字段名，以防止类似问题。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

Springboot整合swagger Boolean类型字段以is开头 字段不显示问题

我的字段

	
	/**
     * 激活规则（是否需要激活）
     */
    @ApiModelProperty("激活规则（是否需要激活）")
    private Boolean needActivation;
    
	/**
     * 激活后立即核销（是否激活立即核销 0否 1是）
     */
    @ApiModelProperty("激活后立即核销（是否激活立即核销 0否 1是）")
    private Boolean isWriteOffImmediately;

显示结果（字段少了is，参数说明没有）

参数名称               		参数说明           	 是否必须     		数据类型
needActivation	      激活规则（是否需要激活）     false			boolean
writeOffImmediately							   false	  	    boolean

总结：Boolean尽量不要以is开头

あ训
关注
【SpringBoot】37、SpringBoot整合EasyPoi自定义字典导出Excel
Asurplus
11-06 22万+
前面我们介绍了 SpringBoot 中使用 JeecgBoot 的 Autopoi 导出 Excel，其实 Autopoi 的底层也是 EasyPoi，对于 Excel 的导入/导出也是非常方便的。那 EasyPoi 也是基于 POI 的，如果对这方面想要深究的，可以先看看原生 POI 的导入/导出方式，你会回来选择 EasyPoi 的 一、简介 EasyPoi 功能如同名字 easy，主打的功能就是容易，让一个没见接触过poi的人员就可以方便的写出 Excel 导出，Excel 模板导出，Excel 导
Springboot+swagger 实体类boolean 类型不展示
青汁的博客
06-08 1357
在开发项目过程中，发现形参对象中的boolean类型的字段isWater始终无法被接收，通过查询资料发现，boolean类型的参数应当避免使用is开头进行命名，因为该类型的 参数的set方法会自动命名为is+字段名，如果字段名中是is开头，会产生问题。 ...
Springboot变量名Is开头的一些问题
Soilerest的博客
01-07 1603
使用Springboot框架，定义了一个isRepost变量，使用IDEA生成get和set方法，但生成的get方法为IsRepost()，这就导致了前端接收的变量名变成了repost。 解决方案是手动将IsRepost()方法改成getIsRepost()
swagger @ApiModel 返回内容注释不显示问题
11-17
swagger @ApiModel 返回内容注释不显示问题 展开无类信息
【SpringBoot】 不要在实体类里给boolean属性取前缀名 is
piano_diano的博客
02-25 1378
背景 今天在写项目时，给某个实体类里的属性取名带前缀"is" private boolean isImg; 接着我把实体类返回给前端后发现 ？？？为什么我的is前缀被吞了 解决 不要给boolean类型的属性取名带"is"前缀 // whether or no private boolean wonImg; ...
Swagger字段属性说明不显示
qq_33240556的博客
05-23 3102
解决此问题的一般步骤是先检查模型类上的注解是否完整且正确，然后检查Swagger的配置，最后考虑是否存在版本兼容性或前端显示问题。：有时候问题可能不在后端配置，而是前端Swagger UI的显示问题。：如果使用了特定的JSON序列化库（如Jackson或Gson），确保它们的配置没有无意间排除了Swagger需要的元数据。：确保在模型类（实体类）的字段或getter/setter方法上使用了Swagger提供的注解来提供描述信息。：检查Swagger配置是否正确开启了模型属性的展示。
某字段不展示在Swagger文档中
baidu_26367533的博客
12-17 2977
swagger文档中不展示某些字段
swagger 指定字段不显示到文档里
weixin_33724570的博客
11-17 8201
Swagger UI 隐藏指定接口类或方法 - 宁静致远 - 优快云博客https://blog.youkuaiyun.com/lqh4188/article/details/53538201 swagger 指定字段不显示到文档里 - 帆帆爱苹果 - 优快云博客https://blog.youkuaiyun.com/mengxiangxingdong/article/details/82713008     ...
SpringBoot整合Swagger超详细完整指南
最新发布
weixin_51040479的博客
07-07 1141
本文详细介绍了Swagger在SpringBoot项目中的完整应用指南，主要内容包括： 技术选型与版本对比：比较Springfox与SpringDoc两种实现方案，并提供版本兼容性矩阵 项目配置： 详细的环境准备与项目结构设计 Maven依赖配置示例 多环境（开发/生产）配置文件说明 核心功能实现： 基础配置类与Web配置类详解 完整的注解系统指南（Controller/实体类/枚举类） 实体建模与数据传输设计模式（DTO/VO/统一响应） 企业级实践： 用户管理和认证控制器的完整示例 安全认证配置（JWT
Swagger（SpringBoot集成Swagger 常用Swagger注解）
qq_52897007的博客
07-31 4137
相信无论是前端还是后端开发，都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力，经常来不及更新。其实无论是前端调用后端，还是后端调用后端，都期望有一个好的接口文档。但是这个接口文档对于程序员来说，就跟注释一样，经常会抱怨别人写的代码没有写注释，然而自己写起代码起来，最讨厌的，也是写注释。所以仅仅只通过强制来规范大家是不够的，随着时间推移，版本迭代，接口文档往往很容易就跟不上代码了发现了痛点就要去找解决方案。
Springboot与swagger
游王子og的博客
08-18 1289
在前后端分离开发的过程中，前端和后端需要进行api对接进行交互，就需要一个api规范文档，方便前后端的交互，但api文档不能根据代码的变化发生实时动态的改变，这样后端修改了接口，前端不能及时获取最新的接口，导致调用出错，需要手动维护api文档，加大了开发的工作量和困难，而swagger的出现就是为了解决这一系列的问题。swagger是一套基于OpenAPI规范构建的开源工具，使用RestApi。
SpringBoot整合Swagger2
weixin_43566977的博客
04-02 278
一、问题描述 随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、先后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。 前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要，swagger就是一款让你更好的书写API文档的框架，而且swagger可以完全模拟http请求，入参出参和实际情况差别几乎为零。 没有API文...
swagger踩坑之请求类不显示具体字段
快敲代码去
03-12 954
swagger踩坑之请求类不显示具体字段 省流：枚举字段需要加上@ApiModelProperty注解
Swagger 文档中响应体新增字段不显示
a1011259215的博客
06-15 660
ApiModel(value=“Response对象”, description=“响应对象”)ApiModel 中 value值相等的 只会取第一个 所以不要起重名了!
Swagger不显示接口注释
标准都是留给不爱的人，爱的本质是自由意志的沉沦
12-20 2969
1、缺少 XML 注释文件：Swagger 默认使用 XML 注释文件中的注释来生成接口文档。确保在项目的生成设置中启用了 XML 文档生成，并将生成的 XML 注释文件放置在与生成的 DLL 文件相同的目录下。2、修改Program.cs文件，在Build之前增加Swagger的配置项。，路径可以为空指向默认路径。请在右击->属性->生成。
swagger（springfox）统一对象返回值 字段属性说明不显示
qq_40202111的博客
03-27 1199
首先确认返回对象是否 使用泛型来返回，如： 然后就是返回controller层是否有返回 如果以上都没有问题就是springfox的一个bug，在2.0.6等后面的高版本中由于升级了Springfox基础组件，如果我们使用到JRebel这类热加载插件的时候，会出现类字段没有的情况，目前没有办法解决springfox项目与JRebel插件的冲突，唯一的办法就是原来的debug启动
boolean类型变量以is开头时导致springMVC无法获取到正确值的问题
Scluis的博客
01-27 1617
前言 记录前段时间的一个bug，当时坑了我好久，要不是出于偶然发现原因，估计可能现在都没有解决。 问题 在用thymeleaf和springboot的时候发现前台一个boolean类型的变量传递到后台的值一直有问题，无论前台是true还是false，到后台获取到的都是false，对此我很是费解，反复确认后台接口和前台请求都是没有问题的，是对应的，仔细调试发现前台提交后boolean值还是true，一进到后台接口就变成了false，简直是让人吐血，一时间不知道怎么下手，病急乱投医，没想到把变量名改了居然解决了
swagger查询结果中注释不显示问题
JUST DO IT，就是干IT！
12-01 3963
基本的注解不多说了，大家都会，注意点就是controller层的返回结果，如果包装了泛型，需要明确指出，如下图红框 注：如果红框中直接写为Object 返回值什么都正常，但是字段注解不会显示
【遇坑解决】当在Swagger中备注好字段后，入参返参却不显示的解决
XiaoChen~Coder
10-19 1781
当在Swagger中备注好字段后，返参却不显示的解决
springboot 订单类型 枚举类型
03-10
<think>好的，用户想在Spring Boot中实现订单类型的枚举类型，并询问最佳实践。我需要先回顾Spring Boot中枚举的使用场景，尤其是在订单类型这类有限选项的情况下。枚举在Java中非常适合表示固定的常量集合，比如订单类型可能有购买、退货、兑换等。 首先，用户可能需要将枚举存储到数据库中，这时候通常会使用JPA的@Enumerated注解。这里需要注意EnumType.ORDINAL和STRING的区别，ORDINAL存储的是枚举的顺序，而STRING存储的是枚举的名称。最佳实践是使用STRING，因为即使枚举顺序改变，数据也不会出错。 接下来，考虑如何在REST API中处理枚举。Spring MVC默认可以将字符串参数转换为枚举类型，但为了更好的前后端交互，可能需要自定义序列化和反序列化逻辑。例如，使用@JsonValue和@JsonCreator注解，确保JSON中使用的是用户友好的名称而不是枚举的name()值。 另外，用户可能需要在数据库中存储枚举的描述信息，而不仅仅是名称。这时候可以在枚举中定义额外的字段，比如code和description，并在构造函数中初始化。这样在实体类中，可以通过@Enumerated(EnumType.STRING)来存储code，同时提供可读的description用于前端显示。 还有，验证用户输入是否为有效的枚举值。可以使用@Valid注解配合自定义验证器，或者在DTO中使用@Pattern注解限制输入的字符串必须匹配枚举的某个值。不过更推荐使用Spring的Converter或转换服务，自动处理参数绑定时的类型转换，并抛出有意义的错误信息。 此外，考虑国际化的需求，可能需要根据不同的语言返回不同的描述信息。这时候可以将description设计为从资源文件中读取，但通常在枚举中直接定义多语言的字段可能更简单，或者在后端处理翻译逻辑。 测试也是重要的一环，确保枚举值能够正确持久化到数据库，并且在API请求中能够正确转换。可以编写单元测试和集成测试，使用@DataJpaTest和@WebMvcTest来分别测试持久层和控制器层。 最后，参考Spring官方文档和社区的最佳实践，比如使用Project Lombok的@Getter简化代码，保持枚举类的简洁和可维护性。同时，确保枚举的命名清晰，符合业务需求，避免将来扩展时的冲突。</think>在Spring Boot中实现订单类型枚举的最佳实践可分为以下几个关键步骤： ### 一、基础枚举定义 ```java public enum OrderType { PURCHASE("PURCHASE", "购买订单"), RETURN("RETURN", "退货订单"), EXCHANGE("EXCHANGE", "兑换订单"); private final String code; private final String description; OrderType(String code, String description) { this.code = code; this.description = description; } // 使用@JsonValue确保序列化时输出code @JsonValue public String getCode() { return code; } @JsonCreator public static OrderType fromCode(String code) { return Arrays.stream(OrderType.values()) .filter(type -> type.code.equalsIgnoreCase(code)) .findFirst() .orElseThrow(() -> new IllegalArgumentException("无效的订单类型")); } } ``` ### 二、数据库映射 在JPA实体中使用`@Enumerated`注解： ```java @Entity public class Order { @Enumerated(EnumType.STRING) // 推荐使用STRING而非ORDINAL @Column(length = 20) private OrderType orderType; } ``` 此方式会将枚举的`code`值存储为字符串，保证数据库可读性和枚举顺序无关性[^1] ### 三、DTO序列化处理 ```java public class OrderDto { @Schema(description = "订单类型", example = "PURCHASE") @NotNull(message = "订单类型不能为空") private OrderType orderType; } ``` Spring Boot会自动处理枚举与JSON字符串的转换[^2] ### 四、验证增强 1. 自定义验证注解： ```java @Target({FIELD, PARAMETER}) @Retention(RUNTIME) @Constraint(validatedBy = ValidOrderTypeValidator.class) public @interface ValidOrderType { String message() default "无效的订单类型"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; } ``` 2. 验证器实现： ```java public class ValidOrderTypeValidator implements ConstraintValidator<ValidOrderType, String> { @Override public boolean isValid(String value, ConstraintValidatorContext context) { return Arrays.stream(OrderType.values()) .anyMatch(type -> type.getCode().equalsIgnoreCase(value)); } } ``` ### 五、国际化支持 在`messages.properties`中配置： ```properties enum.OrderType.PURCHASE=Purchase Order enum.OrderType.RETURN=Return Order ``` 通过MessageSource获取本地化描述： ```java public String getLocalizedDescription(OrderType type, Locale locale) { return messageSource.getMessage("enum.OrderType." + type.name(), null, locale); } ``` ### 六、最佳实践建议 1. **不可变性**：确保枚举字段为final 2. **文档化**：使用Swagger的`@Schema`注解说明枚举值 3. **异常处理**：在`@ExceptionHandler`中处理`IllegalArgumentException` 4. **性能优化**：缓存`values()`数组的遍历结果 5. **测试覆盖**： ```java @Test void should_convert_from_code() { assertThat(OrderType.fromCode("PURCHASE")).isEqualTo(OrderType.PURCHASE); } ``` ### 七、进阶实现 1. **数据库转换器**（适用于复杂映射）： ```java @Converter(autoApply = true) public class OrderTypeConverter implements AttributeConverter<OrderType, String> { @Override public String convertToDatabaseColumn(OrderType attribute) { return attribute.getCode(); } @Override public OrderType convertToEntityAttribute(String dbData) { return OrderType.fromCode(dbData); } } ``` 2. **Spring Data查询支持**： ```java public interface OrderRepository extends JpaRepository<Order, Long> { List<Order> findByOrderType(OrderType orderType); } ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值