百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分类 > 正文

SpringWeb的Controller接口开发实用技巧

ztj100 2024-12-15 18:01 11 浏览 0 评论

1. 统一路径

如果你希望所有Controller接口对外都有统一的路径,那么你可以通过如下方式进行配置

@Configuration
public class WebConfig implements WebFluxConfigurer {


  @Override
  public void configurePathMatching(PathMatchConfigurer configurer) {
    configurer.addPathPrefix("/api", t -> true) ;
  }
}

这使得所有的Controller请求必须统一加"/api"前缀。

2. 静态资源注册

在SpringBoot环境下,默认支持以下位置的静态资源访问:

classpath:[/META-INF/resources/, /resources/, /static/, /public/]

你可以通过如下方式注册自定义位置的静态资源访问

@Component
public class StaticResourceConfig implements WebMvcConfigurer {


  @Override
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
    // 本地系统路径 要指明前缀:file:
    registry.addResourceHandler("/static/**").addResourceLocations("file:D:/images/") ;
  }
  
}

3. 参数验证

关于参数验证基本上我们都是使用的基于注解的方式,只要项目中引入spring-boot-starter-validation就可以使用基于注解@Validated@Valid对Controller请求参数进行验证。如果你的验证不是基于注解的,而是自定义的验证逻辑,那么你可以通过如下方式注册自己的验证器。

@RestController
@RequestMapping("/users")
public class UserController {


    @InitBinder
    protected void initBinder(WebDataBinder binder) {
        binder.addValidators(new UserValidator()) ;
    }
}
// UserValidator验证器
public class UserValidator implements Validator {
  @Override
  public boolean supports(Class<?> clazz) {
    return clazz.isAssignableFrom(User.class) ;
  }


  @Override
  public void validate(Object target, Errors errors) {
    User user = (User) target ;
    if (user.getAge() > 150) {
      errors.reject("age", "年龄不能超过150") ;
    }
    if (user.getName() == null || user.getName().equals("")) {
      errors.reject("name", "姓名不能为空") ;
    }
  }
}

4. 异常处理

很多时候我们都会自定义自己的@RestControllerAdvice类,在该类中定义使用@ExceptionHandler注解的方法进行全局的异常拦截统一处理。这种方式应该是最简单最有效的处理方式了。其实在SpringWeb中提供了一个ResponseEntityExceptionHandler类,该类是个抽象类,该类定义了@ExceptionHandler方法,该异常处理句柄能够处理常见的一些异常,我们可以基础该类,针对这些不同的异常进行特殊的处理。

@Component
public class CustomResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {


  @Override
  protected ResponseEntity<Object> handleExceptionInternal(Exception ex, Object body, HttpHeaders headers,
      HttpStatus status, WebRequest request) {
    // 实现自己的逻辑
    return new ResponseEntity<>(ex.getMessage(), headers, status) ;
  } 
}

默认支持如下的异常处理

5. 获取请求完整信息

Controller接口获取整个请求的完整信息可以通过HttpEntity对象进行接收,该对象暴露了请求头和请求体。

@RetController
@RequestMapping("/users")
public class UserController {
  @PostMapping("")
  public Object save(HttpEntity<User> entity) {
    // 通过HttpEntity可以获取body及header信息。
  }
}

6. 内置跨域Filter

Spring Web提供了内置过滤器解决跨域问题。可以通过如下方式配置注册:

@Bean
CorsFilter corsFitler() {
  CorsConfiguration config = new CorsConfiguration();


  config.setAllowCredentials(true);
  config.addAllowedOrigin("http://www.pack.com");
  config.addAllowedHeader("*");
  config.addAllowedMethod("*");


  UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
  source.registerCorsConfiguration("/**", config);
  CorsFilter filter = new CorsFilter(source);
  return filter ;
}

7. 修改默认错误页

在SpringBoot中,默认配置了/error错误展示页。我们可通过如下方式自定义错误页的处理逻辑

@RestController
@RequestMapping("/error")
public class PackErrorController implements ErrorController {
  
  @GetMapping("")
  public Object e() {
    return "error..." ;
  }
}

ErrorController接口没有定义任何的方法,所以我们只需要按照正常编写Controller进行即可。不过你需要注意你这里的请求uri要和配置文件中的uri一致,否则会出现404。你可以通过如下配置修改默认的错误uri。

server:
  error:
    #上面自定义的ErrorController要与这里的配置一致
    path: /pack/error

8. 正确获取ServletContext

在嵌入式容器设置中,ServletContext 是在应用程序上下文初始化过程中作为服务器启动的一部分设置的。因此,ApplicationContext 中的 Bean 无法可靠地使用 ServletContext 进行初始化。解决这个问题的方法之一是将 ApplicationContext 作为 bean 的依赖注入,只有在需要时才访问 ServletContext。另一种方法是在服务器启动后使用回调。可以使用 ApplicationListener 监听 ApplicationStartedEvent,具体方法如下:

@Component
public class PackComponent implements ApplicationListener<ApplicationStartedEvent> {


  private final ServletContext servletContext;


  @Override
  public void onApplicationEvent(ApplicationStartedEvent event) {
    ApplicationContext applicationContext = event.getApplicationContext() ;
    this.servletContext = ((WebApplicationContext) applicationContext).getServletContext() ;
  }
}

ApplicationStartedEvent事件将会在整个应用程序基本启动完成后发布(调用相应*Runner回调之前)。

以上是本篇文章的全部内容,希望对你有帮助。


公众号:Spring全家桶实战案例源码

相关推荐

Whoosh,纯python编写轻量级搜索工具

引言在许多应用程序中,搜索功能是至关重要的。Whoosh是一个纯Python编写的轻量级搜索引擎库,可以帮助我们快速构建搜索功能。无论是在网站、博客还是本地应用程序中,Whoosh都能提供高效的全文搜...

如何用Python实现二分搜索算法(python二分法查找代码)

如何用Python实现二分搜索算法二分搜索(BinarySearch)是一种高效的查找算法,适用于在有序数组中快速定位目标值。其核心思想是通过不断缩小搜索范围,每次将问题规模减半,时间复杂度为(O...

路径扫描 -- dirsearch(路径查找器怎么使用)

外表干净是尊重别人,内心干净是尊重自己,干净,在今天这个时代,应该是一种极高的赞美和珍贵。。。----网易云热评一、软件介绍Dirsearch是一种命令行工具,可以强制获取web服务器中的目录和文件...

78行Python代码帮你复现微信撤回消息!

来源:悟空智能科技本文约700字,建议阅读5分钟。本文基于python的微信开源库itchat,教你如何收集私聊撤回的信息。...

从零开始学习 Python!2《进阶知识》 Python进阶之路

欢迎来到Python学习的进阶篇章!如果你说已经掌握了基础语法,那么这篇就是你开启高手之路的大门。我们将一起探讨面向对象编程...

白帽黑客如何通过dirsearch脚本工具扫描和收集网站敏感文件

一、背景介绍...

Python之txt数据预定替换word预定义定位标记生成word报告(四)

续接Python之txt数据预定替换word预定义定位标记生成word报告(一)https://mp.toutiao.com/profile_v4/graphic/preview?pgc_id=748...

假期苦短,我用Python!这有个自动回复拜年信息的小程序

...

Python——字符串和正则表达式中的反斜杠(&#39;\&#39;)问题详解

在本篇文章里小编给大家整理的是关于Python字符串和正则表达式中的反斜杠('\')问题以及相关知识点,有需要的朋友们可以学习下。在Python普通字符串中在Python中,我们用'\'来转义某些普通...

Python re模块:正则表达式综合指南

Python...

Python中re模块详解(rem python)

在《...

python之re模块(python re模块sub)

re模块一.re模块的介绍1.什么是正则表达式"定义:正则表达式是一种对字符和特殊字符操作的一种逻辑公式,从特定的字符中,用正则表达字符来过滤的逻辑。(也是一种文本模式;)2、正则表达式可以帮助我们...

MySQL、PostgreSQL、SQL Server 数据库导入导出实操全解

在数字化时代,数据是关键资产,数据库的导入导出操作则是连接数据与应用场景的桥梁。以下是常见数据库导入导出的实用方法及代码,包含更多细节和特殊情况处理,助你应对各种实际场景。一、MySQL数据库...

Zabbix监控系统系列之六:监控 mysql

zabbix监控mysql1、监控规划在创建监控项之前要尽量考虑清楚要监控什么,怎么监控,监控数据如何存储,监控数据如何展现,如何处理报警等。要进行监控的系统规划需要对Zabbix很了解,这里只是...

mysql系列之一文详解Navicat工具的使用(二)

本章内容是系列内容的第二部分,主要介绍Navicat工具的使用。若查看第一部分请见:...

取消回复欢迎 发表评论: