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

SpringWeb的Controller接口开发实用技巧

ztj100 2024-12-15 18:01 32 浏览 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全家桶实战案例源码

相关推荐

sharding-jdbc实现`分库分表`与`读写分离`

一、前言本文将基于以下环境整合...

三分钟了解mysql中主键、外键、非空、唯一、默认约束是什么

在数据库中,数据表是数据库中最重要、最基本的操作对象,是数据存储的基本单位。数据表被定义为列的集合,数据在表中是按照行和列的格式来存储的。每一行代表一条唯一的记录,每一列代表记录中的一个域。...

MySQL8行级锁_mysql如何加行级锁

MySQL8行级锁版本:8.0.34基本概念...

mysql使用小技巧_mysql使用入门

1、MySQL中有许多很实用的函数,好好利用它们可以省去很多时间:group_concat()将取到的值用逗号连接,可以这么用:selectgroup_concat(distinctid)fr...

MySQL/MariaDB中如何支持全部的Unicode?

永远不要在MySQL中使用utf8,并且始终使用utf8mb4。utf8mb4介绍MySQL/MariaDB中,utf8字符集并不是对Unicode的真正实现,即不是真正的UTF-8编码,因...

聊聊 MySQL Server 可执行注释,你懂了吗?

前言MySQLServer当前支持如下3种注释风格:...

MySQL系列-源码编译安装(v5.7.34)

一、系统环境要求...

MySQL的锁就锁住我啦!与腾讯大佬的技术交谈,是我小看它了

对酒当歌,人生几何!朝朝暮暮,唯有己脱。苦苦寻觅找工作之间,殊不知今日之事乃我心之痛,难道是我不配拥有工作嘛。自面试后他所谓的等待都过去一段时日,可惜在下京东上的小金库都要见低啦。每每想到不由心中一...

MySQL字符问题_mysql中字符串的位置

中文写入乱码问题:我输入的中文编码是urf8的,建的库是urf8的,但是插入mysql总是乱码,一堆"???????????????????????"我用的是ibatis,终于找到原因了,我是这么解决...

深圳尚学堂:mysql基本sql语句大全(三)

数据开发-经典1.按姓氏笔画排序:Select*FromTableNameOrderByCustomerNameCollateChinese_PRC_Stroke_ci_as//从少...

MySQL进行行级锁的?一会next-key锁,一会间隙锁,一会记录锁?

大家好,是不是很多人都对MySQL加行级锁的规则搞的迷迷糊糊,一会是next-key锁,一会是间隙锁,一会又是记录锁。坦白说,确实还挺复杂的,但是好在我找点了点规律,也知道如何如何用命令分析加...

一文讲清怎么利用Python Django实现Excel数据表的导入导出功能

摘要:Python作为一门简单易学且功能强大的编程语言,广受程序员、数据分析师和AI工程师的青睐。本文系统讲解了如何使用Python的Django框架结合openpyxl库实现Excel...

用DataX实现两个MySQL实例间的数据同步

DataXDataX使用Java实现。如果可以实现数据库实例之间准实时的...

MySQL数据库知识_mysql数据库基础知识

MySQL是一种关系型数据库管理系统;那废话不多说,直接上自己以前学习整理文档:查看数据库命令:(1).查看存储过程状态:showprocedurestatus;(2).显示系统变量:show...

如何为MySQL中的JSON字段设置索引

背景MySQL在2015年中发布的5.7.8版本中首次引入了JSON数据类型。自此,它成了一种逃离严格列定义的方式,可以存储各种形状和大小的JSON文档,例如审计日志、配置信息、第三方数据包、用户自定...

取消回复欢迎 发表评论: