前言
今天在编写文件上传代码时对静态资源进行映射时遇到了一个Bug与各位看官进行分享，首先先复现一下Bug。
复现过程
文件上传类
/**
* 文件的上传与下载
*/
@Slf4j
@RestController
@RequestMapping("/common")
public class CommonController {
@Value("${file.upload.path}")
private String uploadPath;
/**
* 文件上传 MultipartFile file这个file要跟前端的name匹配
* 返回文件的访问路径
*/
@PostMapping("/upload")
public String uploadfiles(MultipartFile file, HttpServletRequest request) {
try {
//文件大小
long size = file.getSize();
//1.获取原文件名称
String oldFileName = file.getOriginalFilename();
//2.获取文件后缀
String extension = oldFileName.substring(oldFileName.lastIndexOf("."));
//3.生成新文件名称(由时间+去掉-的UUID+文件后缀组成)
String newFileName = new SimpleDateFormat("yyyyMMddHHmmss").format(new Date()) + UUID.randomUUID().toString().replace("-", "") + extension;
//5.文件类型
String type = file.getContentType();
//通过拼接的方式，拼出带有时间的路径
String dateformat = new SimpleDateFormat("yyyy-MM-dd").format(new Date());
String dateDirPath = uploadPath + dateformat;
File dateDir = new File(dateDirPath);
//如果当前日期的文件夹不存在则创建
if (!dateDir.exists()) dateDir.mkdirs();
//7.文件上传
file.transferTo(new File(dateDirPath, newFileName));
//8.返回上传的文件路径
String baseUrl = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort() + request.getContextPath();
return baseUrl + "/upload/" + dateformat + "/" + newFileName;
} catch (Exception e) {
return e.getMessage();
}
}
}静态资源映射类，记住这里继承WebMvcConfigurationSupport会埋下伏笔！
/**
* 配置类，注册web层相关组件
*/
@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {
@Value("${file.upload.dir}")
String realPaths;
/**
* 设置静态资源映射
*
* @param registry
*/
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
//配置server虚拟路径，handler为前台访问的目录，locations为files相对应的本地路径
registry.addResourceHandler("/upload/**").addResourceLocations("file:" + realPaths);
}
}这样配置后，就可以将上传的文件，通过返回的路径正常的访问到，但是这样就引申出了一个问题，那么就是继承WebMvcConfigurationSupport有什么用？继承WebMvcConfigurationSupport类后可以完全替代SpringBoot对WebMVC的自动配置。
进入正题，来看我的bug，以下是具体代码，在我们继承继承WebMvcConfigurationSupport类后：
User 实体类
public class User implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 用户ID
*/
@TableId(value = "uid", type = IdType.AUTO)
private Integer uid;
/**
* 用户名
*/
private String username;
/**
* 密码
*/
private String password;
/**
* 昵称
*/
private String nike;
/**
* 年龄
*/
private Integer age;
/**
* 性别
*/
private String sex;
/**
* 联系方式
*/
private String phone;
/**
* 车牌号
*/
private String card;
/**
* 余额
*/
private Double money;
/**
* 角色。0系统管理员，1车主
*/
private Integer role;
/**
* 创建时间
*/
@TableField("create_time")
private LocalDateTime createTime;
// set/get方法省略
}
UserController，service以及dao实现逻辑省略
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/getUserByUid")
public ResultJson<User> gerUserByUid(Integer uid){
ResultJson<User> success = ResultJson.success(userService.getById(uid));
return success;
}
}在经过以上操作后，你就会发现当访问接口以后LocalDateTime类型的createTime会返回成一个数组[2024, 6, 16, 20, 22, 10]，分析这种情况是如何发生的，首先继承WebMvcConfigurationSupport类后会完全替代SpringBoot对WebMVC的自动配置，那么为什么继承WebMvcConfigurationSupport类后会完全替代SpringBoot对WebMVC的自动配置成了我们的疑问，经过翻看源码不难发现，当SpringBoot项目引入Web起步依赖后会自动装配WebMvcAutoConfiguration配置类，加载SpringMvc中默认的配置，如果有类继承WebMvcConfigurationSupport后SpringMvc中自动装配配置类会失效，从而达到继承WebMvcConfigurationSupport就可以实现自定义配置类。
//WebMvc自动装配类的部分源码
@Configuration(
proxyBeanMethods = false
)
@ConditionalOnWebApplication(
type = Type.SERVLET
)
@ConditionalOnClass({Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class})
@ConditionalOnMissingBean({WebMvcConfigurationSupport.class}) //当有类继承WebMvcConfigurationSupport后WebMvc自动装配配置类会失效
@AutoConfigureOrder(-2147483638)
@AutoConfigureAfter({DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class, ValidationAutoConfiguration.class})
public class WebMvcAutoConfiguration {}WebMvcAutoConfiguration到底为我们提供哪些默认配置呢？
-
MessageConverters: 自动配置了一组默认的HttpMessageConverter，包括处理 JSON、XML、字符串、字节数组等格式的转换器。其中包括了 MappingJackson2HttpMessageConverter和StringHttpMessageConverter等。
-
静态资源处理: 配置了静态资源的处理，例如处理classpath:/META-INF/resources/、classpath:/resources/、classpath:/static/、classpath:/public/等位置的静态资源。
-
视图解析器: 配置了ContentNegotiatingViewResolver，用于根据请求的 Accept 头信息选择合适的视图解析器（如 JSP、Thymeleaf 等）。
-
日期和时间格式化: 默认情况下，会注册FormattingConversionService来处理日期和时间的格式化，使得在控制器中直接使用@DateTimeFormat注解来格式化日期和时间参数。
-
数据绑定: 使用WebDataBinder进行数据绑定，支持从请求参数到控制器方法的参数转换。
-
异常处理器: 自动配置了DefaultHandlerExceptionResolver 和 ResponseEntityExceptionHandler，用于处理全局的异常情况并返回合适的响应。
-
跨域请求配置: 支持 CORS（跨源资源共享）配置，允许跨域请求的设定。
-
参数解析器: 注册了一些常用的参数解析器，例如 RequestParamMethodArgumentResolver、PathVariableMethodArgumentResolver 等，用于处理请求中的参数并传递给控制器方法。
-
视图控制器: 配置了默认的欢迎页和错误页的处理。
那么到底是以上哪个默认配置失效会导致我们LocalDateTime类型的createTime会返回成一个数组[2024, 6, 16, 20, 22, 10]呢？在 Spring Boot 中，日期的消息转换类主要是通过MappingJackson2HttpMessageConverter来处理的，它使用 Jackson 库来进行日期的序列化和反序列化，具体来说，MappingJackson2HttpMessageConverter 提供了多种日期序列化和反序列化的选项，主要由 Jackson 库中的 com.fasterxml.jackson.databind.ObjectMapper 实例来配置和控制，默认情况下，MappingJackson2HttpMessageConverter 使用 Jackson 的默认日期格式进行序列化和反序列化，即 ISO-8601 格式，例如yyyy-MM-dd'T'HH:mm:ss.SSSZ。
解决方案
解决方法一
改用实现WebMvcConfigurer接口
/**
* 配置类，注册web层相关组件
*/
@Configuration
public class WebMvcConfiguration implements WebMvcConfigurer {
@Value("${file.upload.path}")
String realPaths;
/**
* 设置静态资源映射
*/
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
//配置server虚拟路径，handler为前台访问的目录，locations为files相对应的本地路径
registry.addResourceHandler("/upload/**").addResourceLocations("file:" + realPaths);
}
}继承WebMvcConfigurationSupport和实现WebMvcConfigurer的区别
继承WebMvcConfigurationSupport和实现WebMvcConfigurer的主要区别在于它们对 Spring Boot 默认配置的影响和扩展能力：
-
WebMvcConfigurationSupport 类继承：
- 完全替代默认配置：继承WebMvcConfigurationSupport类会完全替代 Spring Boot 对 Web MVC 的自动配置。这意味着你需要手动配置和添加所有的 MVC 配置，包括消息转换器、视图解析器、静态资源处理等。Spring Boot 的默认配置都不会被应用，除非你在子类中显式配置它们。
- 灵活性和控制：这种方式提供了最高的灵活性和控制，你可以精确地定义每一个 MVC 组件的行为和配置，但也需要更多的工作来确保所有必要的配置都被正确地添加和管理。
-
实现 WebMvcConfigurer 接口：
- 保留部分默认配置：实现WebMvcConfigurer接口允许你在不完全替代 Spring Boot 默认配置的情况下，对 MVC 的行为进行定制。你可以选择性地重写需要定制的方法，如添加资源处理器、修改视图解析器、添加拦截器等，而不会影响其他配置如消息转换器等。
- 简化和集成：通过实现接口，你可以保留和集成 Spring Boot 自动配置的部分，避免手动重写和配置整个 MVC 的所有方面。这种方式更符合大多数应用的需求，因为通常只需针对特定需求进行少量的配置和扩展。
选择适当的方式：
-
推荐实践：通常情况下，推荐使用实现
WebMvcConfigurer接口的方式来定制 MVC 配置。这种方式可以保留 Spring Boot 提供的大部分自动配置，同时允许你进行必要的定制。这样可以减少不必要的工作量，并确保应用能够继续受益于 Spring Boot 的自动配置能力。 -
使用 WebMvcConfigurationSupport 的情况：只有在需要完全控制 MVC 配置、或者有特殊的需求需要完全替代 Spring Boot 默认配置时，才建议继承
WebMvcConfigurationSupport类。
解决方案二
自定义日期格式
1.通过配置文件修改全局格式
可以在application.properties或application.yml中配置 spring.jackson.date-format属性来指定全局的日期格式。例如：
spring.jackson.date-format=yyyy-MM-dd2.通过 ObjectMapper 配置
可以在 Spring Boot 应用的任何配置类中注入ObjectMapper并配置日期格式，然后将其注册到MappingJackson2HttpMessageConverter中。例如：
@Configuration
public class JacksonConfig {
@Bean
public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd"));
return new MappingJackson2HttpMessageConverter(objectMapper);
}
}
3.通过注解配置日期格式
在需要特定日期格式的 POJO 类型上使用 Jackson 提供的 @JsonFormat 注解来指定该字段的序列化和反序列化格式。例如：
public class User implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 用户ID
*/
@TableId(value = "uid", type = IdType.AUTO)
private Integer uid;
/**
* 用户名
*/
private String username;
/**
* 密码
*/
private String password;
/**
* 昵称
*/
private String nike;
/**
* 年龄
*/
private Integer age;
/**
* 性别
*/
private String sex;
/**
* 联系方式
*/
private String phone;
/**
* 车牌号
*/
private String card;
/**
* 余额
*/
private Double money;
/**
* 角色。0系统管理员，1车主
*/
private Integer role;
/**
* 创建时间
*/
@JsonFormat(pattern="yyyy-MM-dd")
@TableField("create_time")
private LocalDateTime createTime;
// set/get方法省略
}
扫一扫
1472
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
