2024年前后端分离springmvc和RESTful理解，2024年最新通用流行框架大全

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上物联网嵌入式知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、电子书籍、讲解视频，并且后续会持续更新

如果你需要这些资料，可以戳这里获取

16. setSerializationInclusion(JsonInclude.Include.NON_NULL);
17. // 进行缩进输出
18. configure(SerializationFeature.INDENT_OUTPUT, true);
19. // 将驼峰转为下划线
20. if (camelCaseToLowerCaseWithUnderscores) {
21. setPropertyNamingStrategy(PropertyNamingStrategy.CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES);
22. }
23. // 进行日期格式化
24. if (StringUtil.isNotEmpty(dateFormatPattern)) {
25. DateFormat dateFormat = new SimpleDateFormat(dateFormatPattern);
26. setDateFormat(dateFormat);
27. }
28. }
29. }

然后，将CustomObjectMapper注入到MappingJackson2HttpMessageConverter中，Spring配置如下：

[xml]
view plain
copy

6. mvc:annotation-driven
7. mvc:message-converters
11. </mvc:message-converters>
12. </mvc:annotation-driven>

通过以上过程，我们已经完成了一个基于Spring MVC的REST框架，只不过该框架还非常单薄，还缺乏很多关键性特性，尤其是异常处理。

4.3 处理异常行为

在Spring MVC中，我们可以使用AOP技术，编写一个全局的异常处理切面类，用它来统一处理所有的异常行为，在Spring 3.2中才开始提供。使用法很简单，只需定义一个类，并通过@ControllerAdvice注解将其标注即可，同时需要使用@ResponseBody注解表示返回值可序列化为JSON字符串。代码如下：

[java]
view plain
copy

1. @ControllerAdvice
2. @ResponseBody
3. public class ExceptionAdvice {
5. /**
6. * 400 - Bad Request
7. */
8. @ResponseStatus(HttpStatus.BAD_REQUEST)
9. @ExceptionHandler(HttpMessageNotReadableException.class)
10. public Response handleHttpMessageNotReadableException(HttpMessageNotReadableException e) {
11. logger.error(“参数解析失败”, e);
12. return new Response().failure(“could_not_read_json”);
13. }
15. /**
16. * 405 - Method Not Allowed
17. */
18. @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
19. @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
20. public Response handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) {
21. logger.error(“不支持当前请求方法”, e);
22. return new Response().failure(“request_method_not_supported”);
23. }
25. /**
26. * 415 - Unsupported Media Type
27. */
28. @ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
29. @ExceptionHandler(HttpMediaTypeNotSupportedException.class)
30. public Response handleHttpMediaTypeNotSupportedException(Exception e) {
31. logger.error(“不支持当前媒体类型”, e);
32. return new Response().failure(“content_type_not_supported”);
33. }
35. /**
36. * 500 - Internal Server Error
37. */
38. @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
39. @ExceptionHandler(Exception.class)
40. public Response handleException(Exception e) {
41. logger.error(“服务运行异常”, e);
42. return new Response().failure(e.getMessage());
43. }
44. }

可见，在ExceptionAdvice类中包含一系列的异常处理方法，每个方法都通过@ResponseStatus注解定义了响应状态码，此外还通过@ExceptionHandler注解指定了具体需要拦截的异常类。以上过程只是包含了一部分的异常情况，若需处理其它异常，可添加方法具体的方法。需要注意的是，在运行时从上往下依次调用每个异常处理方法，匹配当前异常类型是否与@ExceptionHandler注解所定义的异常相匹配，若匹配，则执行该方法，同时忽略后续所有的异常处理方法，最终会返回经JSON序列化后的Response对象。

4.4 支持参数验证

我们回到上文所提到的示例，这里处理一个普通的POST请求，代码如下：

[java]
view plain
copy

1. @RestController
2. public class AdvertiserController {
4. @RequestMapping(value = “/advertiser”, method = RequestMethod.POST)
5. public Response createAdvertiser(@RequestBody AdvertiserParam advertiserParam) {
6. …
7. }
8. }

其中，AdvertiserParam参数包含若干属性，通过以下类结构可见，它是一个传统的POJO：

[java]
view plain
copy

1. public class AdvertiserParam {
3. private String advertiserName;
5. private String description;
7. // 省略 getter/setter 方法
8. }

如果业务上需要确保AdvertiserParam对象的advertiserName属性必填，如何实现呢？
若将这类参数验证的代码写死在Controller中，势必会与正常的业务逻辑搅在一起，导致责任不够单一，违背于“单一责任原则”。建议将其参数验证行为从Controller中剥离出来，放到另外的类中，这里仅提供一个@Valid注解来定义AdvertiserParam参数，并在AdvertiserParam类中通过@NotEmpty注解来定义advertiserName属性，就像下面这样：

[java]
view plain
copy

1. @RestController
2. public class AdvertiserController {
4. @RequestMapping(value = “/advertiser”, method = RequestMethod.POST)
5. public Response createAdvertiser(@RequestBody @Valid AdvertiserParam advertiserParam) {
6. …
7. }
8. }
10. public class AdvertiserParam {
12. @NotEmpty
13. private String advertiserName;
15. private String description;
17. // 省略 getter/setter 方法
18. }

这里的@Valid注解实际上是Validation Bean规范提供的注解，该规范已由Hibernate Validator框架实现，因此需要添加以下Maven依赖到pom.xml文件中：

[xml]
view plain
copy

2. org.hibernate
3. hibernate-validator
4. ${hibernate-validator.version}

需要注意的是，Hibernate Validator与Hibernate没有任何依赖关系，唯一有联系的只是都属于JBoss公司的开源项目而已。
要实现@NotEmpty注解的功能，我们需要做以下几件事情。

首先，定义一个@NotEmpty注解类，代码如下：

[java]
view plain
copy

1. @Documented
2. @Target({ElementType.FIELD, ElementType.PARAMETER})
3. @Retention(RetentionPolicy.RUNTIME)
4. @Constraint(validatedBy = NotEmptyValidator.class)
5. public @interface NotEmpty {
7. String message() default “not_empty”;
9. Class<?>[] groups() default {};
11. Class<? extends Payload>[] payload() default {};
12. }

以上注解类必须包含message、groups、payload三个属性，因为这是规范所要求的，此外，需要通过@Constraint注解指定一个验证器类，这里对应的是NotEmptyValidator，其代码如下：

[java]
view plain
copy

1. public class NotEmptyValidator implements ConstraintValidator<NotEmpty, String> {
3. @Override
4. public void initialize(NotEmpty constraintAnnotation) {
5. }
7. @Override
8. public boolean isValid(String value, ConstraintValidatorContext context) {
9. return StringUtil.isNotEmpty(value);
10. }
11. }

以上验证器类实现了ConstraintValidator接口，并在该接口的isValid( )方法中完成了具体的参数验证逻辑。需要注意的是，实现接口时需要指定泛型，第一个参数表示验证注解类型（NotEmpty），第二个参数表示需要验证的参数类型（String）。
然后，我们需要在Spring配置文件中开启该特性，需添加如下配置：

[xml]
view plain
copy

最后，需要在全局异常处理类中添加参数验证处理方法，代码如下：

[java]
view plain
copy

1. @ControllerAdvice
2. @ResponseBody
3. public class ExceptionAdvice {
5. /**
6. * 400 - Bad Request
7. */
8. @ResponseStatus(HttpStatus.BAD_REQUEST)
9. @ExceptionHandler(ValidationException.class)
10. public Response handleValidationException(ValidationException e) {
11. logger.error(“参数验证失败”, e);
12. return new Response().failure(“validation_exception”);
13. }
14. }

至此，REST框架已集成了Bean Validation特性，我们可以使用各种注解来完成所需的参数验证行为了。
看似该框架可以在本地成功跑起来，整个架构包含两个应用，前端应用提供纯静态的HTML页面，后端应用发布REST API，前端需要通过AJAX调用后端发布的REST API，然而AJAX是不支持跨域访问的，也就是说，前后端两个应用必须在同一个域名下才能访问。这是非常严重的技术障碍，一定需要找到解决方案。

4.5 解决跨域问题

比如，前端应用为静态站点且部署在http://web.xxx.com域下，后端应用发布REST API并部署在http://api.xxx.com域下，如何使前端应用通过AJAX跨域访问后端应用呢？这需要使用到CORS技术来实现，这也是目前最好的解决方案了。

[CORS全称为Cross Origin Resource Sharing（跨域资源共享），服务端只需添加相关响应头信息，即可实现客户端发出AJAX跨域请求。]

CORS技术非常简单，易于实现，目前绝大多数浏览器均已支持该技术（IE8浏览器也支持了），服务端可通过任何编程语言来实现，只要能将CORS响应头写入response对象中即可。

下面我们继续扩展REST框架，通过CORS技术实现AJAX跨域访问。

首先，我们需要编写一个Filter，用于过滤所有的HTTP请求，并将CORS响应头写入response对象中，代码如下：

[java]
view plain
copy

1. public class CorsFilter implements Filter {
3. private String allowOrigin;
4. private String allowMethods;
5. private String allowCredentials;
6. private String allowHeaders;
7. private String exposeHeaders;
9. @Override
10. public void init(FilterConfig filterConfig) throws ServletException {
11. allowOrigin = filterConfig.getInitParameter(“allowOrigin”);
12. allowMethods = filterConfig.getInitParameter(“allowMethods”);
13. allowCredentials = filterConfig.getInitParameter(“allowCredentials”);
14. allowHeaders = filterConfig.getInitParameter(“allowHeaders”);
15. exposeHeaders = filterConfig.getInitParameter(“exposeHeaders”);
16. }
18. @Override
19. public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
20. HttpServletRequest request = (HttpServletRequest) req;
21. HttpServletResponse response = (HttpServletResponse) res;
22. if (StringUtil.isNotEmpty(allowOrigin)) {
23. List allowOriginList = Arrays.asList(allowOrigin.split(“,”));
24. if (CollectionUtil.isNotEmpty(allowOriginList)) {
25. String currentOrigin = request.getHeader(“Origin”);
26. if (allowOriginList.contains(currentOrigin)) {
27. response.setHeader(“Access-Control-Allow-Origin”, currentOrigin);
28. }
29. }
30. }
31. if (StringUtil.isNotEmpty(allowMethods)) {
32. response.setHeader(“Access-Control-Allow-Methods”, allowMethods);
33. }
34. if (StringUtil.isNotEmpty(allowCredentials)) {
35. response.setHeader(“Access-Control-Allow-Credentials”, allowCredentials);
36. }
37. if (StringUtil.isNotEmpty(allowHeaders)) {
38. response.setHeader(“Access-Control-Allow-Headers”, allowHeaders);
39. }
40. if (StringUtil.isNotEmpty(exposeHeaders)) {
41. response.setHeader(“Access-Control-Expose-Headers”, exposeHeaders);
42. }
43. chain.doFilter(req, res);
44. }
46. @Override
47. public void destroy() {
48. }
49. }

以上CorsFilter将从web.xml中读取相关Filter初始化参数，并将在处理HTTP请求时将这些参数写入对应的CORS响应头中，下面大致描述一下这些CORS响应头的意义：

• Access-Control-Allow-Origin：允许访问的客户端域名，例如：http://web.xxx.com，若为*，则表示从任意域都能访问，即不做任何限制。
• Access-Control-Allow-Methods：允许访问的方法名，多个方法名用逗号分割，例如：GET,POST,PUT,DELETE,OPTIONS。
• Access-Control-Allow-Credentials：是否允许请求带有验证信息，若要获取客户端域下的cookie时，需要将其设置为true。
• Access-Control-Allow-Headers：允许服务端访问的客户端请求头，多个请求头用逗号分割，例如：Content-Type。
• Access-Control-Expose-Headers：允许客户端访问的服务端响应头，多个响应头用逗号分割。

需要注意的是，CORS规范中定义Access-Control-Allow-Origin只允许两种取值，要么为*，要么为具体的域名，也就是说，不支持同时配置多个域名。为了解决跨多个域的问题，需要在代码中做一些处理，这里将Filter初始化参数作为一个域名的集合（用逗号分隔），只需从当前请求中获取Origin请求头，就知道是从哪个域中发出的请求，若该请求在以上允许的域名集合中，则将其放入Access-Control-Allow-Origin响应头，这样跨多个域的问题就轻松解决了。

以下是web.xml中配置CorsFilter的方法：

[xml]
view plain
copy

2. corsFilter
3. com.xxx.api.cors.CorsFilter
5. allowOrigin
6. http://web.xxx.com
9. allowMethods
10. GET,POST,PUT,DELETE,OPTIONS
13. allowCredentials
14. true
17. allowHeaders
18. Content-Type
22. corsFilter
23. /*

完成以上过程即可实现AJAX跨域功能了，但似乎还存在另外一个问题，由于REST是无状态的，后端应用发布的REST API可在用户未登录的情况下被任意调用，这显然是不安全的，如何解决这个问题呢？我们需要为REST请求提供安全机制。

4.6 提供安全机制

解决REST安全调用问题，可以做得很复杂，也可以做得特简单，可按照以下过程提供REST安全机制：

1. 当用户登录成功后，在服务端生成一个token，并将其放入内存中（可放入JVM或Redis中），同时将该token返回到客户端。
2. 在客户端中将返回的token写入cookie中，并且每次请求时都将token随请求头一起发送到服务端。
3. 提供一个AOP切面，用于拦截所有的Controller方法，在切面中判断token的有效性。
4. 当登出时，只需清理掉cookie中的token即可，服务端token可设置过期时间，使其自行移除。

首先，我们需要定义一个用于管理token的接口，包括创建token与检查token有效性的功能。代码如下：

[java]
view plain
copy

1. public interface TokenManager {
3. String createToken(String username);
5. boolean checkToken(String token);
6. }

然后，我们可提供一个简单的TokenManager实现类，将token存储到JVM内存中。代码如下：

[java]
view plain
copy

1. public class DefaultTokenManager implements TokenManager {
3. private static Map<String, String> tokenMap = new ConcurrentHashMap<>();
5. @Override
6. public String createToken(String username) {
7. String token = CodecUtil.createUUID();
8. tokenMap.put(token, username);
9. return token;
10. }
12. @Override
13. public boolean checkToken(String token) {
14. return !StringUtil.isEmpty(token) && tokenMap.containsKey(token);
15. }
16. }

需要注意的是，如果需要做到分布式集群，建议基于Redis提供一个实现类，将token存储到Redis中，并利用Redis与生俱来的特性，做到token的分布式一致性。
然后，我们可以基于Spring AOP写一个切面类，用于拦截Controller类的方法，并从请求头中获取token，最后对token有效性进行判断。代码如下：

[java]
view plain
copy

1. public class SecurityAspect {
3. private static final String DEFAULT_TOKEN_NAME = “X-Token”;
5. private TokenManager tokenManager;
6. private String tokenName;
8. public void setTokenManager(TokenManager tokenManager) {
9. this.tokenManager = tokenManager;
10. }
12. public void setTokenName(String tokenName) {
13. if (StringUtil.isEmpty(tokenName)) {
14. tokenName = DEFAULT_TOKEN_NAME;
15. }
16. this.tokenName = tokenName;
17. }
19. public Object execute(ProceedingJoinPoint pjp) throws Throwable {
20. // 从切点上获取目标方法
21. MethodSignature methodSignature = (MethodSignature) pjp.getSignature();
22. Method method = methodSignature.getMethod();
23. // 若目标方法忽略了安全性检查，则直接调用目标方法
24. if (method.isAnnotationPresent(IgnoreSecurity.class)) {
25. return pjp.proceed();
26. }
27. // 从 request header 中获取当前 token
28. String token = WebContext.getRequest().getHeader(tokenName);
29. // 检查 token 有效性
30. if (!tokenManager.checkToken(token)) {
31. String message = String.format(“token [%s] is invalid”, token);
32. throw new TokenException(message);
33. }
34. // 调用目标方法
35. return pjp.proceed();
36. }
37. }

若要使SecurityAspect生效，则需要添加如下Spring 配置：

[xml]
view plain
copy

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上物联网嵌入式知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、电子书籍、讲解视频，并且后续会持续更新

如果你需要这些资料，可以戳这里获取

Exception(message);
33. }
34. // 调用目标方法
35. return pjp.proceed();
36. }
37. }

若要使SecurityAspect生效，则需要添加如下Spring 配置：

[xml]
view plain
copy

[外链图片转存中…(img-EJ68cGvG-1715628622481)]
[外链图片转存中…(img-U7LzqCtf-1715628622482)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上物联网嵌入式知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、电子书籍、讲解视频，并且后续会持续更新

如果你需要这些资料，可以戳这里获取