Spring 02 - 스프링 폴더 구조

스프링 폴더 구조

스프링 폴더 구조는 maven 프로젝트 구조와 같습니다.
예시를 통해서 더 자세히 알아보도록 하겠습니다.
예시 프로젝트는 Pet-Clinic입니다.

src/main/java

java 파일들이 들어있습니다.
Controller 와 Model에 해당하는 파일들이 들어있습니다.
이중에서 Controller라는 단어가 붙은 파일들은 아래와 같이 Controller annotation을 가지고 있습니다.

@Controller
class OwnerController {

	private static final String VIEWS_OWNER_CREATE_OR_UPDATE_FORM = "owners/createOrUpdateOwnerForm";

	private final OwnerRepository owners;

	private VisitRepository visits;

	public OwnerController(OwnerRepository clinicService, VisitRepository visits) {
		this.owners = clinicService;
		this.visits = visits;
	}

	@InitBinder
	public void setAllowedFields(WebDataBinder dataBinder) {
		dataBinder.setDisallowedFields("id");
	}

	@GetMapping("/owners/new")
	public String initCreationForm(Map<String, Object> model) {
		Owner owner = new Owner();
		model.put("owner", owner);
		return VIEWS_OWNER_CREATE_OR_UPDATE_FORM;
	}

	@PostMapping("/owners/new")
	public String processCreationForm(@Valid Owner owner, BindingResult result) {
		if (result.hasErrors()) {
			return VIEWS_OWNER_CREATE_OR_UPDATE_FORM;
		}
		else {
			this.owners.save(owner);
			return "redirect:/owners/" + owner.getId();
		}
	}

Controller annotation 이 붙은 파일은 클라이언트의 요청을 비즈니스 로직으로 분기 및 수행결과를 응답하는 역할을 합니다.
즉, 클라이언트 요청이 들어오면 Controller 파일 내부에서 GetMapping anntation 이나 PostMapping annotation이 달린 함수로 요청이 맵핑되서 처리됩니다.

src/main/resources

Resources들(자바코드에서 사용할 리소스들 html, db 등)이 저장되는 디렉터리입니다.

src/test/java

테스트 코드가 들어있습니다.

src/web/WEB-INF

WEB-INF 폴더는 외부에서 직접접근할 수 없습니다.
컨트롤러를 통하여 경유하여 접근할 수 있습니다.
이유: 컴파일된 클래스와 스프링 환경 설정파일이 존재하기 때문입니다. 또한 jsp파일을 외부에서 접속하여 수정되는 것을 방지하기 위함입니다.(보안을 위해서 입니다.)

src/web/WEB-INF/web.xml

톰캣 설정 파일입니다.

src/web/WEB-INF/views

출력할 웹페이지 html, jsp 파일을 가지고 있습니다.

src/web/WEB-INF/dispatcher-servlet.xml

클라이언트로부터 요청이 들어오면 Tomcat과 같은 서블릿컨테이너가 요청을 받는데,
이때 제일 앞에서 서버로 들어오는 모든 요청을 처리하는 프론트 컨트롤러가 존재합니다.
Spring에서는 프론트 컨트롤러를 Dispatcher Servelet에 해당합니다.
따라서 공통 작업을 Dispatcher Servlet 이 처리한 후, 적절한 컨트롤러로 작업을 위임합니다.
dispatcher-servlet.xml이 Dispatcher Servlet에 대한 설정파일입니다.

src/web/WEB-INF/applicatonContext.xml

의존성 주입을 위한 객체들을 미리 정의하는 곳 입니다.
의존성 주입할 객체들을 지정하면서 객체 주입방식을 선택할 수 있습니다. ```

base-package="com.base.guest.repository"

- base-package 범위에서 @Reopository, @Serice, @Component 어노테이션이 붙어져있는 클래스 객체를 싱글톤 행태로 생성하여 IoC Container에 저장됩니다.

### .iml 
- IntelliJ 가 생성한 모듈 파일입니다.
- .iml 파일은 개발 모듈에 대한 정보를 가지고 있습니다.
- 개발모듈에 대한 정보: 모듈 경로, dependency들, 그외 다른 설정

### pom.xml

<?xml version=”1.0” encoding=”UTF-8”?>

4.0.0 org.springframework.samples spring-petclinic 2.3.0.BUILD-SNAPSHOT org.springframework.boot spring-boot-starter-actuator org.springframework.boot spring-boot-starter-cache

- maven에서 참조하는 설정파일입니다.  
- maven은 빌드와 관련된 정보를 프로젝트 객체모델(Proejct Object Model)이라는 이름으로 정의하고 사용하는데, 이 객체모델이 pom.xml입니다.
- 설정하고 싶은 라이브러리가 있으면 pom.xml파일에서 dependency 태그를 추가하고 라이브러리를 추가하면 됩니다. 
- maven이 pom.xml을 읽어서 서술된 라이브러리를 jar파일로 로컬저장소에 다운 받아줍니다.
- = spring의 장점: 기존의 웹프로젝트는 모든 라이브러리 파일을 직접 다운 받아서 적용해야했습니다. 반면에 spring은 dependency 태그만 적어주면, 알아서 적용시켜줍니다. 또한 다른 프로젝트에서 같은 dependency 태그를 적어주면, 별도의 다운로드 없이 로컬 저장소에 저장된 라이브러리를 자동으로 가져다가 사용합니다.
 
### target 디렉터리
- maven으로 빌드하면 생기는 jar 파일을 저장하는 곳입니다.
- 개발할 때는 중요하지 않지만, jar파일을 실제 서버에 반영할 때 target 디렉터리안에 잇는 jar 파일이나 war 파일을 배포하게 됩니다.

## 동작 과정
1. 웹 어플리케이션이 실행되면, ServletContainter(ex. 톰캣 서버)이 자신의 설정 파일인 web.xml을 로딩합니다.

2. web.xml 등록되어있는 ContextLoaderListener (Java ClasS)의 인스턴스가 메모리에 생성됩니다.

- web.xml 등록된 ContextLoaderListner 코드 

org.springframework.web.context.ContextLoaderListener

- ContextLoaderListner는 ServletContextListenr 인터페이스를 구현하고 있으며, Root Application Context를 생성하는 역할을 합니다. (정확히는 ContextLoaderListner 내부에 부모객체로 존재하는 ContextLoader가 Root Application Context는 생성합니다.)

	<br/>

3. 생성된 ContextLoaderListener 는 applicationContext.xml을 로딩하여 스프링 IoC Container에 해당하는 Root Application Context 생성합니다.

- 또한 applicationContext.xml 에 등록된 bean들이 생성되어 Root Applicatoin Context에 저장됩니다.

- 이때 생성되는 bean들은 웹과 관련없는 객체들입니다.

- 예를 들어, DB에 접근하기 위한 객체인 repository나 databaseDataSource 클래스 객체를 생성합니다.
- applicationContext.xml 코드 예시입니다.

- context:component-scan 태그를 통해서 ContextLoaderListner내부의 ContextLoader가 bean 생성위해 스캔할 범위(base-package)를 지정합니다.

- context:component-scan 태그의 하위태그로 include-filter태그를 추가하여 스캔할 대상을 지정합니다.
- 위에서는 @Repository, @Service, @Component 어노테이션이 붙은 클래스를 스캔하여 bean으로 생성한다는 의미입니다.
- 여기까지가 톰캣이 시작될 때 수행되는 과정입니다.

<br/>

4. 클라이언트로 부터 요청이 들어오면, 요청이 들어온 url 을 보고 해당 <servelt-mappring> 태그를 참조하여 요청에 대응하는 servlet을 맵핑시켜줍니다.
- web.xml 의 servlet 관련 코드
	

dispatcher

org.springframework.web.servlet.DispatcherServlet

<servlet-mapping>
    <servlet-name>dispatcher</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping> ``` - web.xml에는 <servlet> 태그를 통해서 사용할 dispatcher가 설정되어있습니다. - 위에서는 url-pattern이 /인것이 dispatcher 서블렛으로 지정되어있기 때문에 모든 요청이 dispatcher 서블렛과 맵핑됩니다. - 만약 해당 서블릿으로 요청이 처음들어온 경우라면, servel-name에 해당하는 dispatcher뒤에 -servlet.xml이 붙은 dispatcher-servlet.xml 파일을 읽어드립니다. - dispatcher-servlet.xml 에는 아래와 같은 내용을 담고 있습니다.

<mvc:annotation-driven></mvc:annotation-driven> <!-- Annotation 활성화 -->
    <context:component-scan base-package="Controller"/><!-- Component 패키지 지정 -->
	

이는 DispatcherServlet이 요청을 받았을 때 base-package 범위에서 @Controller 어노테이션으로 지정된 것을 스캔한다는 코드입니다.
따라서 아래와 같이 base-package에 속한 클래스의 선언부에 @Controller 어노테이션을 추가하면 해당 클래스는 스캔이 되어 싱글톤 형태의 객체로 생성됩니다. 그리고 생성된 객체는 Web Application Context(IoC 컨테이너)에 저장됩니다.
dispatcher-servlet.xml에서 설정한 anntation 뿐만 아니라, 여러 annotaion 을 스캔합니다. 그 중 하나가 @Autowired라는 어노테이션입니다. @Autowired이 지정된 변수에 Root Applicatoin Context 에 존재하는 객체를 가져다가 넣게 됩니다. 즉, @Autowired가 지정된 변수에 의존성 주입이 일어납니다.
또한 @RequestMapping 이라는 annotaion 을 만나게 되면, Handler Mapping을 하게 됩니다.
즉, 어떤 요청이 올 때 어떤 메서드를 실행하는지 맵핑 테이블을 만들게 됩니다.
개발자는 @RequestMapping 어노테이션을 이용하여 요청 URL 과 메소드를 연결하고, 해당 메소드에 수행할 작업을 작성하면됩니다. (보통 Controller의 메소드에 @RequestMapping 어노테이션이 쓰이기 때문에, 해당 메소드에서 수행할 로직은 주로 데이터를 받아와서 뷰페이지에 전달하는 로직입니다.)

@Controller
class OwnerController {
	private static final String VIEWS_OWNER_CREATE_OR_UPDATE_FORM = "owners/createOrUpdateOwnerForm";
	@GetMapping("/owners/new")
	public String initCreationForm(Map<String, Object> model) {
		Owner owner = new Owner();
		model.put("owner", owner);
		return VIEWS_OWNER_CREATE_OR_UPDATE_FORM;
	}
}

MappingTable이 생성된 이후 들어오는 요청은 DispatcherServlet이 service() 메서드를 실행하여 HandlerMapping에게 질의를 합니다. HanldlerMapping에 대한 질의 결과를 통해 요청을 메소드에게 mapping시킵니다.

참고 :

https://doublesprogramming.tistory.com/16

https://victorydntmd.tistory.com/161

https://mangkyu.tistory.com/18

https://mangkyu.tistory.com/13

http://lazyrodi.github.io/2017/09/03/2017-09-03-spring-structure/

https://doublesprogramming.tistory.com/84

← Previous Post Next Post →