Spring MVC拦截器跟Spring拦截器相比,它里面能够获取HttpServletRequest
和HttpServletResponse
等web对象实例。
Spring MVC拦截器的顶层接口是:HandlerInterceptor
,包含三个方法:
preHandle()
方法 - 用于在将请求发送到控制器之前执行操作。此方法应返回true
,以将响应返回给客户端。postHandle()
目标方法执行后执行afterCompletion()
请求完成时执行为了方便我们一般情况会用HandlerInterceptor
接口的实现类HandlerInterceptorAdapter
类。
拦截器应用场景:
第一步,继承HandlerInterceptorAdapter
类定义拦截器:
public class AuthInterceptor extends HandlerInterceptorAdapter {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
String requestUrl = request.getRequestURI();
if (checkAuth(requestUrl)) {
return true;
}
return false;
}
private boolean checkAuth(String requestUrl) {
System.out.println("===权限校验===");
return true;
}
}
第二步,将该拦截器注册到Spring容器:
@Configuration
public class WebAuthConfig implements WebMvcConfigurer {
@Bean
public AuthInterceptor getAuthInterceptor() {
return new AuthInterceptor();
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(getAuthInterceptor()).addPathPatterns("/**");
}
}
过滤器是 Java Servlet 规范中定义的,它能够在请求传送给 Servlet 之前,对 ServletRequest 和 ServletResponse 做检查和修改,起到了过滤的作用。
过滤器应用场景:
Spring Boot 中的过滤器是基于 Servlet 过滤器。第一步,定义过滤器的类,该类必须继承 Filter 接口。
public class MyFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest req = (HttpServletRequest) request;
System.out.println("MyFilter: "+ req.getRequestURI());
chain.doFilter(request, response);//这步使得请求能够继续传导下去,如果没有的话,请求就在此结束
}
@Override
public void destroy() {
}
}
第二步,注册过滤器,这步骤有 3 种方法。
方法 1. 在配置类中实现一个 FilterRegistrationBean 对象。
配置类实现方式
@Configuration
public class WebConfig {
@Bean
public FilterRegistrationBean<MyFilter> abcFilter() {
FilterRegistrationBean<MyFilter> filterRegBean = new FilterRegistrationBean<>();
filterRegBean.setFilter(new MyFilter());
filterRegBean.addUrlPatterns("/api/*");
filterRegBean.setOrder(Ordered.LOWEST_PRECEDENCE -1);
return filterRegBean;
}
}
方法 2. 使用`@Component 和@Order 注解注册。
使用@Component
@Order(Ordered.LOWEST_PRECEDENCE -1)
@Component
public class MyFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest req = (HttpServletRequest) request;
System.out.println("MyFilter: "+ req.getRequestURI());
chain.doFilter(request, response);//这步使得请求能够继续传导下去,如果没有的话,请求就在此结束
}
@Override
public void destroy() {
}
}
这种方法的缺点是不能再指定 UrlPatterns,默认的 URL 模式就是/*
方法 3. 使用@WebFilter 和@ServletComponentScan 注解,@WebFilter 注解是 Servlet3.0 中的注解,SpringBoot 能够支持该注解,通过@ServletComponentScan 注解,能够扫描并注册到 Servlet 容器中。
@WebFilter方式
@WebFilter(urlPatterns="/api/*")
public class MyFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest req = (HttpServletRequest) request;
System.out.println("MyFilter: "+ req.getRequestURI());
chain.doFilter(request, response);//这步使得请求能够继续传导下去,如果没有的话,请求就在此结束
}
@Override
public void destroy() {
}
}
还需要@ServletComponentScan 注解
@ServletComponentScan
@SpringBootApplication
public class SpringbootlearnApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootlearnApplication.class, args);
}
}
@WebFilter 方式,可以支持 UrlPatterns 的设置,但是不支持 Order 的设置。
1、过滤器和拦截器触发时机不一样,过滤器是在请求进入容器后,但请求进入servlet之前进行预处理的。请求结束返回也是,是在servlet处理完后,返回给前端之前。
2、拦截器可以获取IOC容器中的各个bean,而过滤器就不行,因为拦截器是Spring提供并管理的,Spring的功能可以被拦截器使用,在拦截器里注入一个service,可以调用业务逻辑。而过滤器是JavaEE标准,只需依赖servlet api ,不需要依赖Spring。
3、过滤器的实现基于回调函数。而拦截器(代理模式)的实现基于反射
4、Filter是依赖于Servlet容器,属于Servlet规范的一部分,而拦截器则是独立存在的,可以在任何情况下使用。
5、Filter的执行由Servlet容器回调完成,而拦截器通常通**过动态代理(反射)**的方式来执行。
6、Filter的生命周期由Servlet容器管理,而拦截器则可以通过IoC容器来管理,因此可以通过注入等方式来获取其他Bean的实例,因此使用会更方便。
在做文件上传是使用String path = ResourceUtils.getURL("classpath:").getPath();
或者 String realPath = ClassUtils.getDefaultClassLoader().getResource("static").getPath();
获取上传路径的时候是target目录下,也就是说,只要target目录没了,文件也就没了,这个是我们不想看到的。还有一种经常使用的方式就是直接将上传文件存到磁盘中,但是我们在前端却不能直接引用磁盘里的真实路径的文件,因为这个存在安全问题,所以这个时候,我们就要用web服务器来帮我们做一个虚拟映射,我们访问一个虚拟路径,其实访问的就是本机的真实路径,这样保证了安全性。
file:
###静态资源对外暴露的访问路径
staticAccessPath: /api/file/**
###静态资源实际存储路径
uploadFolder: G:/staticResource/upload/
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
@Value("${file.staticAccessPath}")
private String staticAccessPath;
@Value("${file.uploadFolder}")
private String uploadFolder;
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler(staticAccessPath).addResourceLocations("file:" + uploadFolder);
}
}
@Value("${file.uploadFolder}")
private String uploadFolder;
@PostMapping("/project/upload/{id}")
public ResultVO<?> fileupload(MultipartFile file, HttpServletRequest req,@PathVariable Long id) throws FileNotFoundException {
//使用UUID生成唯一标识文件名
String randomNumber = UUID.randomUUID().toString().replace("-", "");
//获取文件的原始名
String oldFilename = file.getOriginalFilename();
//获取文件后缀 .pdf
String extension = oldFilename.substring(oldFilename.lastIndexOf("."));
//生成新的文件名
String newFileName = randomNumber + extension;
File dateDir = new File(uploadFolder);
if (!dateDir.exists()) {
//判断目录是否存在,不存在则直接创建
dateDir.mkdirs();
}
try {
file.transferTo(new File(dateDir, newFileName));
} catch (IOException e) {
e.printStackTrace();
return ResultVO.fail("上传失败");
}
//上传完毕,可以把上传地址保存到数据库或者直接返回前端显示
String invented_address = req.getScheme()+"://"+req.getServerName()+":"+req.getServerPort() + "/api/file/" + newFileName;
Project project = new Project();
project.setId(id);
project.setInterfaceDocUrl(invented_address);
projectService.updateById(project);
return ResultVO.ok("上传成功");
}
实现类必须是容器中的bean,否则无法获取容器对象ApplicationContext
@Component
public class SpringContextUtil<T> implements BeanFactoryAware {
private BeanFactory beanFactory;
@Override
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
this.beanFactory = beanFactory;
}
public T getBean(Class<T> clazz) {
return beanFactory.getBean(clazz);
}
}
实现BeanFactoryAware
接口,然后重写setBeanFactory
方法,就能从该方法中获取到Spring容器对象。
实现类必须是容器中的bean,否则无法获取容器对象ApplicationContext
@Component
public class SpringContextUtil2<T> implements ApplicationContextAware {
private ApplicationContext applicationContext;
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
public T getBean(Class<T> clazz) {
return applicationContext.getBean(clazz);
}
}
实现ApplicationContextAware
接口,然后重写setApplicationContext
方法,也能从该方法中获取到Spring容器对象。
实现类必须是容器中的bean,否则无法获取容器对象ApplicationContext
@Component
public class SpringContextUtil3<T> implements ApplicationListener<ContextRefreshedEvent> {
private ApplicationContext applicationContext;
@Override
public void onApplicationEvent(ContextRefreshedEvent event) {
applicationContext = event.getApplicationContext();
}
public T getBean(Class<T> clazz) {
return applicationContext.getBean(clazz);
}
}
以前我们在开发接口时,如果出现异常,为了给用户一个更友好的提示,例如:
@RestController
public class ExtController {
@GetMapping("/add")
public String add() {
int a = 10 / 0;
return "成功";
}
}
如果不做任何处理请求add接口结果直接报错:
这种交互方式给用户的体验非常差,为了解决这个问题,我们通常会在接口中捕获异常:
@GetMapping("/add")
public String add() {
String result = "成功";
try {
int a = 10 / 0;
} catch (Exception e) {
result = "数据异常";
}
return result;
}
接口改造后,出现异常时会提示:“数据异常”,对用户来说更友好。
如果只是一个接口还好,但是如果项目中有成百上千个接口,都要加上异常捕获代码吗?答案是否定的,这时全局异常处理就派上用场了:RestControllerAdvice
。
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
public String handleException(Exception e) {
if (e instanceof ArithmeticException) {
return "数据异常";
}
if (e instanceof Exception) {
return "服务器内部异常";
}
retur nnull;
}
}
只需在handleException
方法中处理异常情况,业务接口中可以放心使用,不再需要捕获异常(有人统一处理了)
Spring目前支持3中类型转换器:
这3种类型转换器使用的场景不一样,我们以Converter
例。假如:接口中接收参数的实体对象中,有个字段的类型是Date,但是实际传参的是字符串类型:2023-01-03 10:20:15,要如何处理呢?为
第一步,定义一个实体User:
@Data
public class User {
private Long id;
private String name;
private Date registerDate;
}
第二步,实现Converter
接口:
@Component
public class DateConverter implements Converter<String, Date> {
private SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
@Override
public Date convert(String source) {
if (source != null && !"".equals(source)) {
try {
simpleDateFormat.parse(source);
} catch (ParseException e) {
e.printStackTrace();
}
}
return null;
}
}
第三步,将新定义的类型转换器注入到Spring容器中:
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Autowired
private DateConverter dateConverter;
@Override
public void addFormatters(FormatterRegistry registry) {
registry.addConverter(dateConverter);
}
}
【SpringMVC应用篇】SpringMVC 参数解析器
有时我们需要在某个配置类中引入另外一些类,被引入的类也加到Spring容器中。这时可以使用@Import
注解完成这个功能。
这种引入方式是最简单的,被引入的类会被实例化bean对象。
public class A {
}
@Import(A.class)
@Configuration
public class TestConfiguration {
}
通过@Import
注解引入A类,Spring就能自动实例化A对象,然后在需要使用的地方通过@Autowired
注解注入即可.
这种引入方式是最复杂的,因为@Configuration
注解还支持多种组合注解,比如:
public class A {
}
public class B {
}
@Import(B.class)
@Configuration
public class AConfiguration {
@Bean
public A a() {
return new A();
}
}
@Import(AConfiguration.class)
@Configuration
public class TestConfiguration {
}
通过@Import
注解引入@Configuration
注解的配置类,会把该配置类相关@Import
、@ImportResource
、@PropertySource
等注解引入的类进行递归,一次性全部引入。
这种引入方式需要实现ImportSelector
接口:
public class AImportSelector implements ImportSelector {
private static final String CLASS_NAME = "cn.zysheep.service.A";
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
return new String[]{CLASS_NAME};
}
}
@Import(AImportSelector.class)
@Configuration
public class TestConfiguration {
}
这种方式的好处是selectImports
方法返回的是数组,意味着可以同时引入多个类,还是非常方便的。
这种引入方式需要实现ImportBeanDefinitionRegistrar
接口:
public class AImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(A.class);
registry.registerBeanDefinition("a", rootBeanDefinition);
}
}
@Import(AImportBeanDefinitionRegistrar.class)
@Configuration
public class TestConfiguration {
}
这种方式是最灵活的,能在registerBeanDefinitions
方法中获取到BeanDefinitionRegistry
容器注册对象,可以手动控制BeanDefinition的创建和注册。
这四种引入类的方式各有千秋,总结如下:
目前spring中使用比较多的初始化bean的方法有:
方式一、在需要初始化的方法上增加@PostConstruct
注解,这样就有初始化的能力。
@Service
public class AService {
@PostConstruct
public void init() {
System.out.println("===初始化===");
}
}
方式二、实现InitializingBean
接口,重写afterPropertiesSet
方法,该方法中可以完成初始化功能。
@Component
public class ConstantPropertiesUtils implements InitializingBean {
@Value("${weixin.appid}")
private String appid;
@Value("${weixin.partner}")
private String partner;
@Value("${weixin.partnerkey}")
private String partnerkey;
public static String APPID;
public static String PARTNER;
public static String PARTNERKEY;
@Override
public void afterPropertiesSet() throws Exception {
APPID = appid;
PARTNER = partner;
PARTNERKEY = partnerkey;
}
}
Spring IOC在实例化Bean对象之前,需要先读取Bean的相关属性,保存到BeanDefinition
对象中,然后通过BeanDefinition对象,实例化Bean对象。
如果想修改BeanDefinition对象中的属性,该怎么办呢?
答:我们可以实现BeanFactoryPostProcessor
接口。
@Component
public class MyBeanFactoryPostProcessor implements BeanFactoryPostProcessor {
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {
DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) configurableListableBeanFactory;
BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class);
beanDefinitionBuilder.addPropertyValue("id", 123);
beanDefinitionBuilder.addPropertyValue("name", "zysheep");
defaultListableBeanFactory.registerBeanDefinition("user", beanDefinitionBuilder.getBeanDefinition());
}
}
在postProcessBeanFactory方法中,可以获取BeanDefinition的相关对象,并且修改该对象的属性。
有时,你想在初始化Bean前后,实现一些自己的逻辑。
这时可以实现:BeanPostProcessor
接口。
该接口目前有两个方法:
@Component
public class MyBeanPostProcessor implements BeanPostProcessor {
@Override
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
if (bean instanceof User) {
((User) bean).setUserName("zysheep");
}
return bean;
}
}
如果spring中存在User对象,则将它的userName设置成:zysheep。
其实,我们经常使用的注解,比如:@Autowired、@Value、@Resource、@PostConstruct等,是通过AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor实现的。
实现 CommandLineRunner接口的类会在bean被IOC容器装配完成之后(容器初始化完成后执行)被调用,适合预加载类及其它资源;也可以使用ApplicationRunner,使用方法及效果是一样的
好消息是springboot提供了:
这两个接口帮助我们实现以上需求。
它们的用法还是挺简单的,以ApplicationRunner
接口为例:
@Component
public class TestRunner implements ApplicationRunner {
@Autowired
private LoadDataService loadDataService;
public void run(ApplicationArguments args) throws Exception {
loadDataService.load();
}
}
实现ApplicationRunner
接口,重写run
方法,在该方法中实现自己定制化需求。
如果项目中有多个类实现了ApplicationRunner接口,他们的执行顺序要怎么指定呢?
答案是使用@Order(n)
注解,n的值越小越先执行。当然也可以通过@Priority
注解指定顺序。
有时候,我们需要在关闭spring容器前,做一些额外的工作,比如:关闭资源文件等。
这时可以实现DisposableBean
接口,并且重写它的destroy
方法:
@Service
public class DService implements InitializingBean, DisposableBean {
@Override
public void destroy() throws Exception {
System.out.println("DisposableBean destroy");
}
@Override
public void afterPropertiesSet() throws Exception {
System.out.println("InitializingBean afterPropertiesSet");
}
}
这样spring容器销毁前,会调用该destroy方法,做一些额外的工作。
通常情况下,我们会同时实现InitializingBean
和DisposableBean
接口,重写初始化方法和销毁方法。
我们都知道Spring默认支持的Scope
只有两种:
Spring web又对Scope进行了扩展,增加了:
即便如此,有些场景还是无法满足我们的要求。
比如,我们想在同一个线程中从Spring容器获取到的bean都是同一个对象,该怎么办?这就需要自定义Scope了。
第一步、实现Scope接口:
public class ThreadLocalScope implements Scope {
private static final ThreadLocal THREAD_LOCAL_SCOPE = new ThreadLocal();
@Override
public Object get(String name, ObjectFactory<?> objectFactory) {
Object value = THREAD_LOCAL_SCOPE.get();
if (value != null) {
return value;
}
Object object = objectFactory.getObject();
THREAD_LOCAL_SCOPE.set(object);
return object;
}
@Override
public Object remove(String name) {
THREAD_LOCAL_SCOPE.remove();
return null;
}
@Override
public void registerDestructionCallback(String name, Runnable callback) {
}
@Override
public Object resolveContextualObject(String key) {
return null;
}
@Override
public String getConversationId() {
return null;
}
}
第二步、将新定义的Scope注入到spring容器中:
@Component
public class ThreadLocalBeanFactoryPostProcessor implements BeanFactoryPostProcessor {
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
beanFactory.registerScope("threadLocalScope", new ThreadLocalScope());
}
}
第三步、使用新定义的Scope:
@Scope("threadLocalScope")
@Service
public class CService {
public void add() {
}
}
大多数情况下,我们在开发过程中使用更多的可能是声明式事务
,即使用@Transactional
注解定义的事务,因为它用起来更简单,方便。
只需在需要执行的事务方法上,加上@Transactional
注解就能自动开启事务:
@Service
public class UserService {
@Autowired
private UserMapper userMapper;
@Transactional
public void add(UserModel userModel) {
userMapper.insertUser(userModel);
}
}
这种声明式事务之所以能生效,是因为它的底层使用了AOP,创建了代理对象,调用TransactionInterceptor
拦截器实现事务的功能。
Spring事务有个特别的地方:它获取的数据库连接放在
ThreadLocal
中的,也就是说同一个线程中从始至终都能获取同一个数据库连接,可以保证同一个线程中多次数据库操作在同一个事务中执行。
正常情况下是没有问题的,但是如果使用不当,事务会失效,主要原因如下:
除了上述列举的问题之外,由于@Transactional
注解最小粒度是要被定义在方法上,如果有多层的事务方法调用,可能会造成大事务问题。
一般情况下编程式事务我们可以通过TransactionTemplate
类开启事务功能。有个好消息,就是SpringBoot
已经默认实例化好这个对象了,我们能直接在项目中使用。
@Service
public class UserService {
@Autowired
private TransactionTemplate transactionTemplate;
public void save(final User user) {
transactionTemplate.execute((status) => {
doSameThing...
return Boolean.TRUE;
})
}
}
使用TransactionTemplate
的编程式事务能避免很多事务失效的问题,但是对大事务问题,不一定能够解决,只是说相对于使用@Transactional
注解要好些。
@EnableConfigurationProperties
注解的作用是:让使用了 @ConfigurationProperties
注解的类生效,并且将该类注入到 IOC 容器中,交由 IOC 容器进行管理
实体类有了@EnableConfigurationProperties 注解之后该实体类就不需要加上 @Component 注解了
@Data
// @Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
//lastName必须是邮箱格式
@Email
private String lastName;
private Integer age;
private Boolean boss;
}
PersonController有了@EnableConfigurationProperties
注解之后该实体类就不需要加上 @Component
注解了
@RestController
@RequiredArgsConstructor
@EnableConfigurationProperties(Person.class)
public class PersonController {
final Person person;
@GetMapping("/getPerson")
public String testProperties() {
return person.toString();
}
}