java中如何写拦截器

Java中写拦截器的方法包括：实现HandlerInterceptor接口、继承HandlerInterceptorAdapter类、配置拦截器。 其中，实现HandlerInterceptor接口是最常用的方法。下面将详细描述如何在Java中编写和配置拦截器。

一、实现HandlerInterceptor接口

HandlerInterceptor接口提供了三个方法：preHandle、postHandle、afterCompletion。通过实现这些方法，我们可以在请求处理的不同阶段插入自定义逻辑。

1.1、preHandle方法

preHandle方法在请求处理之前调用。可以在这个方法中进行身份验证、日志记录等操作。

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    // 在这里添加自定义逻辑
    return true; // 返回true继续处理请求，返回false中断请求
}

1.2、postHandle方法

postHandle方法在请求处理之后，但在视图渲染之前调用。可以在这个方法中修改ModelAndView对象。

@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    // 在这里添加自定义逻辑
}

1.3、afterCompletion方法

afterCompletion方法在整个请求完成之后调用。可以在这个方法中进行资源清理等操作。

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    // 在这里添加自定义逻辑
}

二、继承HandlerInterceptorAdapter类

HandlerInterceptorAdapter类是HandlerInterceptor接口的一个适配器实现。通过继承这个类，我们只需要重写需要的方法，而不用实现所有方法。

2.1、重写需要的方法

例如，我们只需要在请求处理之前进行身份验证，可以只重写preHandle方法。

public class CustomInterceptor extends HandlerInterceptorAdapter {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 自定义身份验证逻辑
        return true; // 返回true继续处理请求，返回false中断请求
    }
}

三、配置拦截器

配置拦截器需要在Spring配置文件中进行。可以通过Java配置或者XML配置来完成。

3.1、Java配置

通过Java配置类来注册拦截器。

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new CustomInterceptor()).addPathPatterns("/");
    }
}

3.2、XML配置

通过Spring的XML配置文件来注册拦截器。

<mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/"/>
        <bean class="com.example.CustomInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

四、应用场景

4.1、身份验证

在preHandle方法中进行身份验证，确保用户在访问敏感资源之前已经登录。

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    HttpSession session = request.getSession();
    if (session.getAttribute("user") == null) {
        response.sendRedirect("/login");
        return false;
    }
    return true;
}

4.2、日志记录

在postHandle方法中记录请求处理时间和其他信息。

@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    long startTime = (Long) request.getAttribute("startTime");
    long endTime = System.currentTimeMillis();
    long executeTime = endTime - startTime;
    System.out.println("[" + handler + "] executeTime : " + executeTime + "ms");
}

4.3、资源清理

在afterCompletion方法中进行资源清理操作，例如关闭数据库连接。

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    // 关闭数据库连接
    DatabaseConnection.close();
}

五、注意事项

5.1、线程安全

拦截器是单例的，必须确保线程安全。避免使用线程不安全的实例变量。

5.2、性能影响

拦截器会影响请求的性能，特别是在preHandle方法中进行复杂计算时。应尽量简化拦截器中的逻辑。

5.3、优先级

可以通过配置拦截器的顺序来控制其优先级。例如，身份验证拦截器应在日志记录拦截器之前执行。

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new AuthInterceptor()).order(1);
    registry.addInterceptor(new LoggingInterceptor()).order(2);
}

六、实际案例

6.1、权限管理

在实际项目中，权限管理是一个常见的应用场景。可以通过拦截器来实现用户权限的控制。

public class PermissionInterceptor extends HandlerInterceptorAdapter {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String role = (String) request.getSession().getAttribute("role");
        if (role == null || !role.equals("admin")) {
            response.sendRedirect("/access-denied");
            return false;
        }
        return true;
    }
}

6.2、国际化支持

在请求处理之前，根据用户的区域设置来选择合适的语言。

public class LocaleInterceptor extends HandlerInterceptorAdapter {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String lang = request.getParameter("lang");
        if (lang != null) {
            Locale locale = new Locale(lang);
            LocaleContextHolder.setLocale(locale);
        }
        return true;
    }
}

七、测试

7.1、单元测试

可以使用JUnit进行拦截器的单元测试。通过MockMvc来模拟HTTP请求。

@RunWith(SpringRunner.class)
@WebMvcTest
public class CustomInterceptorTest {
    @Autowired
    private MockMvc mockMvc;
    @Test
    public void testPreHandle() throws Exception {
        mockMvc.perform(get("/some-url"))
               .andExpect(status().isOk());
    }
}

7.2、集成测试

在实际项目中，可以通过集成测试来验证拦截器的行为。

@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
public class CustomInterceptorIntegrationTest {
    @Autowired
    private MockMvc mockMvc;
    @Test
    public void testPreHandleWithValidSession() throws Exception {
        mockMvc.perform(get("/secure-url").sessionAttr("user", new User()))
               .andExpect(status().isOk());
    }
    @Test
    public void testPreHandleWithInvalidSession() throws Exception {
        mockMvc.perform(get("/secure-url"))
               .andExpect(status().is3xxRedirection())
               .andExpect(redirectedUrl("/login"));
    }
}

八、总结

通过实现HandlerInterceptor接口或继承HandlerInterceptorAdapter类，可以轻松地在Java中编写和配置拦截器。拦截器在请求处理的不同阶段提供了插入自定义逻辑的机会，广泛应用于身份验证、日志记录、权限管理等场景。在实际项目中，注意线程安全、性能影响和优先级配置，以确保拦截器的高效运行。