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

SpringWeb的Controller接口开发实用技巧

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

相关推荐

Sublime Text 4 稳定版 Build 4113 发布

IT之家7月18日消息知名编辑器SublimeText4近日发布了Build4113版本,是SublimeText4的第二个稳定版。IT之家了解到,SublimeTe...

【小白课程】openKylin便签贴的设计与实现

openKylin便签贴作为侧边栏的一个小插件,提供便捷的文本记录和灵活的页面展示。openKylin便签贴分为两个部分:便签列表...

“告别 Neovim!为什么我投奔了刚开源的 Zed 编辑器?”

...

壹啦罐罐 Android 手机里的 Xposed 都装了啥

这是少数派推出的系列专题,叫做「我的手机里都装了啥」。这个系列将邀请到不同的玩家,从他们各自的角度介绍手机中最爱的或是日常使用最频繁的App。文章将以「每周一篇」的频率更新,内容范围会包括iOS、...

电气自动化专业词汇中英文对照表(电气自动化专业英语单词)

专业词汇中英文对照表...

Python界面设计Tkinter模块的核心组件

我们使用一个模块,我们要熟悉这个模块的主要元件。如我们设计一个窗口,我们可以用Tk()来完成创建;一些交互元素,按钮、标签、编辑框用到控件;怎么去布局你的界面,我们可以用到pack()、grid()...

以色列发现“死海古卷”新残片(死海古卷是真的吗)

编译|陈家琦据艺术新闻网(artnews.com)报道,3月16日,以色列考古学家发现了死海古卷(DeadSeaScrolls)新残片。新出土的羊皮纸残片中包括以希腊文书写的《十二先知书》段落,这...

鸿蒙Next仓颉语言开发实战教程:订单列表

大家上午好,最近不断有友友反馈仓颉语言和ArkTs很像,所以要注意不要混淆。今天要分享的是仓颉语言开发商城应用的订单列表页。首先来分析一下这个页面,它分为三大部分,分别是导航栏、订单类型和订单列表部分...

哪些模块可以用在 Xposed for Lollipop 上?Xposed 模块兼容性解答

虽然已经有了XposedforLollipop的安装教程,但由于其还处在alpha阶段,一些Xposed模块能不能依赖其正常工作还未可知。为了解决大家对于模块兼容性的疑惑,笔者尽可能多...

利用 Fluid 自制 Mac 版 Overcast 应用

我喜爱收听播客,健身、上/下班途中,工作中,甚至是忙着做家务时。大多数情况下我会用MarcoArment开发的Overcast(Freemium)在iPhone上收听,这是我目前最喜爱的Po...

Avalonia日志组件实现与优化指南(ar日志表扣)

...

浅色Al云食堂APP代码(三)(手机云食堂)

以下是进一步优化完善后的浅色AI云食堂APP完整代码,新增了数据可视化、用户反馈、智能推荐等功能,并优化了代码结构和性能。项目结构...

实战PyQt5: 121-使用QImage实现一个看图应用

QImage简介QImage类提供了独立于硬件的图像表示形式,该图像表示形式可以直接访问像素数据,并且可以用作绘制设备。QImage是QPaintDevice子类,因此可以使用QPainter直接在图...

滚动条隐藏及美化(滚动条隐藏但是可以滚动)

1、滚动条隐藏背景/场景:在移动端,滑动的时候,会显示默认滚动条,如图1://隐藏代码:/*隐藏滚轮*/.ul-scrool-box::-webkit-scrollbar,.ul-scrool...

浅色AI云食堂APP完整代码(二)(ai 食堂)

以下是整合后的浅色AI云食堂APP完整代码,包含后端核心功能、前端界面以及优化增强功能。项目采用Django框架开发,支持库存管理、订单处理、财务管理等核心功能,并包含库存预警、数据导出、权限管理等增...

取消回复欢迎 发表评论: