[Spring]Filter

[Spring]Filter

스프링에서 필터에 대해 알아보자.

Filter

  • Filter란 웹 어플리케이션에서 관리되는 영역
  • 스프링부트 프레임워크에서 요청/응답의 최초와 최종단계에 위치
  • 필터를 통해 요청/응답 정보 변경 가능
  • 유일하게 ServletRequest, ServletResponse 객체를 변환할 수 있음
  • 주로 인증로직과 logging용도로 활용
    • 보통 실무에선 logging용도로 사용되고 intercepter가 인증단계로 사용됨




전역 Filter설정방법과 특정 컨트롤러에만 Filter를 설정하는 방법을 예제 코드와 함께 보자.
차이점으로는 특정 컨트롤러 필터사용시 아래 두 어노테이션을 사용한다는 점이다.

  • @ServletComponentScan
  • @WebFilter("/api2/user/*")



Filter 공통 코드

  • User.java
1
2
3
4
5
6
@Slf4j
@Data
public class User {
private String name;
private int age;
}




전역 Filter 코드 예제

  • FilterApplication.java
1
2
3
4
5
6
7
8
9
@Slf4j
@SpringBootApplication
public class FilterApplication {

public static void main(String[] args) {
SpringApplication.run(FilterApplication.class, args);
}

}
  • controller1.java
1
2
3
4
5
6
7
8
9
10
11
@Slf4j
@RestController
@RequestMapping("/api")
public class ApiController {

@PostMapping("/user")
public User user(@RequestBody User user){
log.info("user1: {}", user);
return user;
}
}
  • GlobalFilter1.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@Slf4j
@Component
public class GlobalFilter implements Filter {

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {

//전처리
ContentCachingRequestWrapper req = new ContentCachingRequestWrapper((HttpServletRequest) request);
ContentCachingResponseWrapper res = new ContentCachingResponseWrapper((HttpServletResponse) response);

chain.doFilter(req, res);
String url = req.getRequestURI();

//후처리
String reqContent = new String(req.getContentAsByteArray()); //default가 UTF-8
log.info("respone url: {}, reqBody: {}", url, reqContent);

String resContent = new String(res.getContentAsByteArray()); //default가 UTF-8
log.info("respone resBody: {}", resContent);
// 필수: 한 번 읽었기때문에 원래대로 copy 돌려놓아야한다.
res.copyBodyToResponse();
}
}




특정 컨트롤러 Filter 코드 예제

  • FilterApplication.java
1
2
3
4
5
6
7
8
9
10
@Slf4j
@SpringBootApplication
@ServletComponentScan //2번방법용
public class FilterApplication {

public static void main(String[] args) {
SpringApplication.run(FilterApplication.class, args);
}

}
  • controller2.java
1
2
3
4
5
6
7
8
9
10
11
12
13
// 이 컨트롤러에만 필터적용
@Slf4j
@RestController
@RequestMapping("/api2")
public class Api2Controller {

@PostMapping("/user")
public User user(@RequestBody User user){
log.info("Api2Controller 컨트롤러에만 GlobalFilter2 필터 적용");
log.info("user2: {}", user);
return user;
}
}
  • GlobalFilter2.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@Slf4j
@WebFilter("/api2/user/*") //특정 컨트롤러에만 사용 가능하도록 설정
public class GlobalFilter2 implements Filter {

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {

//전처리
ContentCachingRequestWrapper req = new ContentCachingRequestWrapper((HttpServletRequest) request);
ContentCachingResponseWrapper res = new ContentCachingResponseWrapper((HttpServletResponse) response);

chain.doFilter(req, res);
String url = req.getRequestURI();

//후처리
String reqContent = new String(req.getContentAsByteArray()); //default가 UTF-8
log.info("respone url: {}, reqBody: {}", url, reqContent);

String resContent = new String(res.getContentAsByteArray()); //default가 UTF-8
log.info("respone resBody: {}", resContent);
// 필수: 한 번 읽었기때문에 원래대로 copy 돌려놓아야한다.
res.copyBodyToResponse();
}
}

Comments