Spring MVC中如何装饰接口驱动型控制器?
我有一个如下的接口驱动型控制器:
@ResponseBody @PreAuthorize("hasAnyRole('ADMIN', 'USER')") @RequestMapping("/foo") interface Foo { @GetMapping("/{id}") String bar(String id); }
还有一个委托实际业务逻辑的实现类:
@Controller public class FooImpl implements Foo { @Override public String bar(String id) { return "<actual business logic>"; } }
我希望装饰Foo接口,为应用添加额外功能。
但使用JDK代理启动应用后,Spring不再注册端点。原因是代理后的Bean类型上不再带有@Controller注解,该注解仅存在于实现类上(且无法在@Bean方法上使用该注解,因为它仅允许用于类型),而Spring MVC识别的是代理类型。同时我也不能同时在装饰类和实现类上标注@Controller,否则会因装饰接口和实现类都被视为需要创建处理器映射的组件而导致映射冲突。
我还希望在实际业务逻辑的实现类上保留@Controller注解,以便明确控制器的核心关注点。
那么,如何在Spring MVC中装饰接口驱动型控制器,同时区分实际实现类和要应用的装饰类?
方法一:利用Spring AOP环绕通知实现增强(推荐)
如果只是需要给控制器方法添加通用增强逻辑(比如日志、参数校验、额外权限校验等),Spring AOP是最简便的方案,无需手动编写装饰器,同时能保留实现类的@Controller注解:
- 创建切面类,定义环绕通知:
@Aspect @Component public class FooControllerAspect { // 匹配Foo接口的bar方法 @Around("execution(* com.yourpackage.Foo.bar(..))") public Object enhanceBarMethod(ProceedingJoinPoint joinPoint) throws Throwable { // 添加前置增强逻辑 System.out.println("执行bar方法前:记录请求ID=" + joinPoint.getArgs()[0]); // 执行原业务逻辑 Object result = joinPoint.proceed(); // 添加后置增强逻辑 System.out.println("执行bar方法后:返回结果=" + result); return result; } }
- 在配置类中开启CGLIB代理(确保代理类继承实现类,保留
@Controller注解):
@Configuration @EnableAspectJAutoProxy(proxyTargetClass = true) public class AopConfig { }
这样Spring会生成FooImpl的CGLIB子类代理,代理类继承了@Controller注解,Spring MVC能正常识别并注册端点,同时自动应用切面中的增强逻辑。
方法二:使用CGLIB动态代理手动实现装饰器
如果需要更灵活的装饰逻辑(比如动态切换装饰器、自定义代理逻辑),可以手动创建CGLIB代理,确保代理类保留@Controller注解:
- 创建配置类,注册代理后的控制器Bean,并标记为
@Primary(优先被Spring MVC使用):
@Configuration public class ControllerProxyConfig { @Bean @Primary public Foo decoratedFoo(FooImpl fooImpl) { ProxyFactory proxyFactory = new ProxyFactory(fooImpl); // 添加自定义方法拦截器,实现装饰逻辑 proxyFactory.addAdvice((MethodInterceptor) invocation -> { // 前置增强 System.out.println("装饰器:执行bar方法前的额外逻辑"); // 调用原方法 Object result = invocation.proceed(); // 后置增强 System.out.println("装饰器:执行bar方法后的额外逻辑"); return result; }); // 使用CGLIB代理(代理目标类,继承@Controller注解) proxyFactory.setProxyTargetClass(true); return (Foo) proxyFactory.getProxy(); } }
这里@Primary注解确保Spring MVC优先使用代理后的Bean,而FooImpl的原始Bean会被代理Bean覆盖,不会产生映射冲突,同时FooImpl上的@Controller注解被代理类继承,Spring MVC能正常识别端点。
方法三:手动注册控制器映射
如果需要完全控制控制器的注册逻辑,可以通过RequestMappingHandlerMapping手动注册装饰器的请求映射:
- 创建装饰器类,实现Foo接口并注入FooImpl:
@Component public class FooDecorator implements Foo { private final FooImpl fooImpl; public FooDecorator(FooImpl fooImpl) { this.fooImpl = fooImpl; } @Override public String bar(String id) { // 自定义装饰逻辑 System.out.println("装饰器逻辑:处理请求ID=" + id); return fooImpl.bar(id); } }
- 创建配置类,手动注册装饰器的请求映射:
@Configuration public class ManualMappingConfig implements ApplicationContextAware { private ApplicationContext applicationContext; @PostConstruct public void registerDecoratorMapping() throws NoSuchMethodException { // 获取Spring MVC的请求映射处理器 RequestMappingHandlerMapping handlerMapping = applicationContext.getBean(RequestMappingHandlerMapping.class); FooDecorator decorator = applicationContext.getBean(FooDecorator.class); // 从接口上获取注解信息,构建请求映射 RequestMapping classMapping = Foo.class.getAnnotation(RequestMapping.class); GetMapping methodMapping = Foo.class.getMethod("bar", String.class).getAnnotation(GetMapping.class); RequestMappingInfo mappingInfo = RequestMappingInfo .paths(classMapping.value()[0] + methodMapping.value()[0]) .methods(RequestMethod.GET) .build(); // 注册装饰器的方法为控制器端点 handlerMapping.registerMapping(mappingInfo, decorator, Foo.class.getMethod("bar", String.class)); } @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { this.applicationContext = applicationContext; } }
- 排除FooImpl的自动映射(避免冲突):
在组件扫描时,排除FooImpl被Spring MVC识别为控制器,可通过@ComponentScan的excludeFilters实现:
@SpringBootApplication @ComponentScan(excludeFilters = @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = FooImpl.class)) public class Application { // 手动注册FooImpl为普通Bean @Bean public FooImpl fooImpl() { return new FooImpl(); } }
这种方式虽然繁琐,但能完全控制控制器的注册逻辑,适合复杂场景。
内容的提问来源于stack exchange,提问作者SpaceTrucker

