TIL

섹션 4 독립 실행형 스프링 애플리케이션

스프링 컨테이너 사용

• 이전에 만든 프론트 컨트롤러를 스프링 컨테이너 안에 넣어볼 거다.
  • 컨테이너가 2개가 된다 - 서블릿 컨테이너, 스프링 컨테이너
• 스프링 컨테이너
  • Container Overview
  • 애플리케이션 컨텍스트라고도 부른다.
• 스프링 컨테이너에 필요한 2가지
  • 비즈니스 로직을 담고 있는 객체 (POJOs)
  • 비즈니스 객체 구성 정보를 갖고 있는 설정 정보 (Configuration metadata)
• 스프링 컨테이너를 코드로 등록해 보려면 GenericApplicationContext를 사용할 수 있다.

public class HellobootApplication {

    public static void main(String[] args) {
        GenericApplicationContext applicationContext = new GenericApplicationContext();
        applicationContext.registerBean(HelloController.class);
        applicationContext.refresh();

        ServletWebServerFactory serverFactory = new TomcatServletWebServerFactory();
        WebServer webServer = serverFactory.getWebServer(context -> {
            context.addServlet("front-controller", new HttpServlet() {
                @Override
                protected void service(HttpServletRequest req,
                                       HttpServletResponse res) throws IOException {
                    // 공통 기능 처리 ...
                    if (req.getRequestURI().equals("/hello") && req.getMethod().equals(HttpMethod.GET.name())) {
                        String name = req.getParameter("name");

                        HelloController helloController = applicationContext.getBean(HelloController.class);
                        String response = helloController.hello(name);

                        res.setContentType(MediaType.TEXT_PLAIN_VALUE);
                        res.getWriter().println(response);
                    } else if (req.getRequestURI().equals("/user")) {
                        // ...
                    } else {
                        res.setStatus(HttpStatus.NOT_FOUND.value());
                    }
                }
            }).addMapping("/*");
        });
        webServer.start();
    }
}

• HelloController를 new로 생성하지 않고 applicationContext에 등록하고 refresh()를 호출하면 빈 등록과 활성화가 끝난다.
• 타입 정보로 빈을 얻을 수 있기에 요청 처리 부분에서 HelloController를 불러와 사용할 수 있다.
• 스프링 컨테이너로 객체를 관리하는 장점
  • 객체(빈)를 딱 하나만 생성할 수 있다. → 싱글톤

의존 오브젝트 추가

• HelloController가 의존하는 SimpleHelloService를 만들어보자.

public class SimpleHelloService {
    String sayHello(String name) {
        return "Hello" + name;
    }
}

public class HelloController {
    public String hello(String name) {
        SimpleHelloService helloService = new SimpleHelloService();
        return helloService.sayHello(Objects.requireNonNull(name));
    }
}

• HelloController는 파라미터 name이 null인지만 체크하고 로직 처리를 위임한다.
• 이렇게 코드를 변경만 해도 /hello 요청은 정상적으로 동작한다.

의존 오브젝트 DI 적용

• SimpleHelloService를 빈으로 등록해 스프링 컨테이너가 DI할 수 있도록 수정해보자
• HelloService 인터페이스를 추가하고 SimpleHelloService를 구현체로 만들고 HelloController에서 생성자 주입을 사용한다.

public interface HelloService {
    String sayHello(String name);
}

public class SimpleHelloService implements HelloService {
    @Override
    public String sayHello(String name) {
        return "Hello" + name;
    }
}

public class HelloController {

    private final HelloService helloService;

    public HelloController(HelloService helloService) {
        this.helloService = helloService;
    }

    public String hello(String name) {
        return helloService.sayHello(Objects.requireNonNull(name));
    }
}

• applicationContext에 SimpleHelloService를 등록하면 스프링 컨테이너가 의존 관계를 조립한다.

GenericApplicationContext applicationContext = new GenericApplicationContext();
applicationContext.registerBean(HelloController.class);
applicationContext.registerBean(SimpleHelloService.class);
applicationContext.refresh();

DispatcherServlet으로 전환

• Servlet Containerless로 가기 위해 DispatcherServlet이 필요하다.
  • 기존 코드는 웹 요청 매핑, 파라미터 바인딩 등의 작업이 하드 코딩 되어 있다.
  • 이런 서블릿 관련 작업을 직접 하기는 번거롭다.

public class HellobootApplication {

    public static void main(String[] args) {
        GenericWebApplicationContext applicationContext = new GenericWebApplicationContext();
        applicationContext.registerBean(HelloController.class);
        applicationContext.registerBean(SimpleHelloService.class);
        applicationContext.refresh();

        ServletWebServerFactory serverFactory = new TomcatServletWebServerFactory();
        WebServer webServer = serverFactory.getWebServer(context -> {
            context.addServlet("dispatcherServlet",
                    new DispatcherServlet(applicationContext)
            ).addMapping("/*");
        });
        webServer.start();
    }
}

• DispatcherServlet을 사용하도록 변경하니 코드가 많이 깔끔해졌지만 매핑 정보가 없어 /hello 요청을 받을 수가 없다.

어노테이션 매핑 정보 사용

@RestController
public class HelloController {

    private final HelloService helloService;

    public HelloController(HelloService helloService) {
        this.helloService = helloService;
    }

    @GetMapping("/hello")
    public String hello(String name) {
        return helloService.sayHello(Objects.requireNonNull(name));
    }
}

• DispatcherServlet은 빈을 모두 뒤져서 매핑 정보를 모두 추출해 알맞은 웹 요청에 호출할 빈을 선택한다.

스프링 컨테이너로 통합

• 기존의 서블릿 컨테이너 초기화 작업을 스프링 컨테이너 초기화 과정 중에 일어나도록 변경해보자.
• GenericWebApplicationContext는 onRefresh 메서드로 refresh 시점에 동작 시킬 작업을 추가할 수 있다.
  • 탬플릿 메서드 패턴의 일환
  • 익명 클래스 기능을 통해 서블릿 초기화 작업을 넣어보자

public class HellobootApplication {

    public static void main(String[] args) {
        GenericWebApplicationContext applicationContext = new GenericWebApplicationContext() {
            @Override
            protected void onRefresh() {
                super.onRefresh();
                ServletWebServerFactory serverFactory = new TomcatServletWebServerFactory();
                WebServer webServer = serverFactory.getWebServer(context ->
                        context.addServlet("dispatcherServlet",
                                new DispatcherServlet(this)
                        ).addMapping("/*"));
                webServer.start();
            }
        };
        applicationContext.registerBean(HelloController.class);
        applicationContext.registerBean(SimpleHelloService.class);
        applicationContext.refresh();
    }
}

자바 코드 구성 정보 사용

• 자바 객체 의존 관계를 맺어줄 때 팩토리 메서드를 이용할 수 있다.
• 팩토리 메서드: 오브젝트 생성 로직을 담고 있는 메서드
  • 빈 객체를 생성하고, 의존 관계를 맺어주는 역할을 할 수 있다.

@Configuration
public class HellobootApplication {

    @Bean
    public HelloController helloController(HelloService helloService) {
        return new HelloController(helloService);
    }

    @Bean
    public HelloService helloService() {
        return new SimpleHelloService();
    }

    public static void main(String[] args) {
        AnnotationConfigWebApplicationContext applicationContext = new AnnotationConfigWebApplicationContext() {
            @Override
            protected void onRefresh() {
                super.onRefresh();
                ServletWebServerFactory serverFactory = new TomcatServletWebServerFactory();
                WebServer webServer = serverFactory.getWebServer(context ->
                        context.addServlet("dispatcherServlet",
                                new DispatcherServlet(this)
                        ).addMapping("/*"));
                webServer.start();
            }
        };
        applicationContext.register(HellobootApplication.class);
        applicationContext.refresh();
    }
}

• GenericWebApplicationContext 대신 AnnotationConfigWebApplicationContext를 사용해야 한다.
• 생성하고 싶은 빈 객체를 반환하는 메서드에 @Bean 어노테이션을 붙이면 스프링 컨테이너가 읽을 수 있다.
• 클래스 레벨에 @Configuration 어노테이션을 붙여야 스프링 컨테이너가 빈 구성 정보가 있는 팩토리 메서드가 있겠구나 판단할 수 있다.
• 자바 구성 정보를 가진 HellobootApplication 클래스를 applicatiojnContext에 등록하면 빈들이 등록된다.

@Component 스캔

• @Component 어노테이션 또는 @Component 어노테이션을 가지는 메타 어노테이션을 클리스 레벨에 붙이면 빈으로 등록할 수 있다.
• HellobootApplication에 @ComponentScan 어노테이션을 붙이면 클래스를 뒤져 @Component 어노테이션을 찾아 스프링 컨테이너에 빈으로 등록한다.

@RestController
public class HelloController {

@Service
public class SimpleHelloService implements HelloService {

@Configuration
@ComponentScan
public class HellobootApplication {

    public static void main(String[] args) {
        AnnotationConfigWebApplicationContext applicationContext = new AnnotationConfigWebApplicationContext() {
            @Override
            protected void onRefresh() {
                super.onRefresh();
                ServletWebServerFactory serverFactory = new TomcatServletWebServerFactory();
                WebServer webServer = serverFactory.getWebServer(context ->
                        context.addServlet("dispatcherServlet",
                                new DispatcherServlet(this)
                        ).addMapping("/*"));
                webServer.start();
            }
        };
        applicationContext.register(HellobootApplication.class);
        applicationContext.refresh();
    }
}

Bean의 생명주기 메서드

• TomcatServletWebServerFactory와 DispatcherServlet은 기능을 담당하는 객체는 아니지만 웹 서버를 실행할 때 꼭 필요한 객체들이다.
  • 이 두 객체 또한 빈으로 등록하여 스프링 컨테이너가 관리하도록 해보자.

@Configuration
@ComponentScan
public class HellobootApplication {

    @Bean
    public ServletWebServerFactory servletWebServerFactory() {
        return new TomcatServletWebServerFactory();
    }

    @Bean
    public DispatcherServlet dispatcherServlet() {
        return new DispatcherServlet();
    }

    public static void main(String[] args) {
        AnnotationConfigWebApplicationContext applicationContext = new AnnotationConfigWebApplicationContext() {
            @Override
            protected void onRefresh() {
                super.onRefresh();
                ServletWebServerFactory serverFactory = this.getBean(ServletWebServerFactory.class);
                DispatcherServlet dispatcherServlet = this.getBean(DispatcherServlet.class);

                WebServer webServer = serverFactory.getWebServer(context ->
                        context.addServlet("dispatcherServlet", dispatcherServlet
                        ).addMapping("/*"));
                webServer.start();
            }
        };
        applicationContext.register(HellobootApplication.class);
        applicationContext.refresh();
    }
}

• TomcatServletWebServerFactory와 DispatcherServlet을 @Bean 어노테이션과 팩토리 메서드로 빈 등록 한다.
• 그러면 onRefresh() 메서드 내부에서 생성하는 것이 아닌 context에서 getBean 메서드로 받아올 수 있다.
• 그런데 DispatcherServlet에 appcliationContext를 생성자에 전달하지도 않았는데 어떻게 동작하는걸까?
  • ApplicationContextAware 인터페이스에 비밀이 있다.

public interface ApplicationContextAware extends Aware {
	void setApplicationContext(ApplicationContext applicationContext) throws BeansException;
}

• DispatcherServlet은 ApplicationContextAware 인터페이스를 구현하고 있다.
  • ApplicationContext를 가지고 있어야 하는 빈이라면 이 인터페이스를 구현하면 자신이 빈으로 등록되는 시점에 스프링 컨테이너가 ApplicationCnotext를 setApplicationContext()로 전달해준다.
• 요즘엔 그냥 빈 객체의 생성자에 ApplicationContext 타입을 받도록 하면 스프링 컨테이너가 알아서 넣어준다.

SpringBootApplication

• applicationContext에 WebServerFactory와 DispahtcherServlet 설정하는 코드를 별도 클래스로 분리해보자.

public class MySpringApplication {

    public static void run(Class<?> applicationClass, String... args) {
        AnnotationConfigWebApplicationContext applicationContext = new AnnotationConfigWebApplicationContext() {
            @Override
            protected void onRefresh() {
                super.onRefresh();
                ServletWebServerFactory serverFactory = this.getBean(ServletWebServerFactory.class);
                DispatcherServlet dispatcherServlet = this.getBean(DispatcherServlet.class);

                WebServer webServer = serverFactory.getWebServer(context ->
                        context.addServlet("dispatcherServlet", dispatcherServlet
                        ).addMapping("/*"));
                webServer.start();
            }
        };
        applicationContext.register(applicationClass);
        applicationContext.refresh();
    }
}

@Configuration
@ComponentScan
public class HellobootApplication {

    @Bean
    public ServletWebServerFactory servletWebServerFactory() {
        return new TomcatServletWebServerFactory();
    }

    @Bean
    public DispatcherServlet dispatcherServlet() {
        return new DispatcherServlet();
    }

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

• 분리하니 스프링 부트를 사용하던 시절의 코드가 많이 비슷해졌다.
• 실제로 MySpringApplication 대신 원래 스프링 부트의 클래스인 SpringApplication으로 대체해도 잘 동작한다.

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