▪️Spring Annotation▪️

---

📖 @Slf4j

기본적으로 인터페이스로 구성, 구현체를 사용해야 한다
log back 라이브러리 사용

📌 Logging

Thread 정보나 클래스 이름 같은 부가정보를 확인
➝ 이제까지는 println으로 콘솔에 출력했다면 별도의 로깅 라이브러리를 사용해 로그를 출력해야한다

@Slf4j // 로깅 사용할 수 있도록 인터페이스 활용
@RestController // 컨트롤러 만들기
public class Slf4jController {

    @RequestMapping("/logging") // 스프링빈 만들기
    public String logging() {

        String sparta = "Sparta";
        // 로그 레벨 : TRACE -> DEBUG -> INFO -> WARN -> ERROR
        // 디폴트 : INFO
        
        // ❎ 실행되지 않는다
        log.trace("문자 trace={}", sparta);
        log.debug("문자 debug={}", sparta);
		
        // ✅ 실행된다
        log.info("문자 info={}", sparta);
        log.warn("문자 warn={}", sparta);
        log.error("문자 error={}", sparta);
        
        return "success";
    }

}

✔️log level

• 용도 : 이 설정을 통해 error만 출력한다던지 (출력모으기)
  로그메세지를 일자별로 모아서 외부 저장소에 보관하기도 한다 (로그 모아놓고 에러 찾기)

🌟 TRACE > DEBUG > INFO > WARN > ERROR

• 위 코드로 설정할 수 있음 (레벨 시작 = TRACE 라는 뜻)
• 따로 설정하지 않으면 기본 레벨(defalut) : INFO

📌 log 사용시 주의할 것

✅	❎
중괄호 사용⭕️	중괄호 사용 ❌ (문자열+문자열) 연산 형태 사용
알아서 괄호랑 문자가 치환되고 로그레벨 적용	로그 레벨 상관없이 연산 먼저 해버린다

---

▪️@Controller VS @RestController▪️

💡 스프링에서 컨트롤러를 만들때 사용하는 어노테이션

---

📖 @Controller

@Controller
public class ViewController {

    @RequestMapping("/view")
    public String example() {
        // logic
        return "sparta"; // ViewName이 return된다 (리소스의 타임리프로 만든 뷰)
    }

}

• 응답할 View가 있는 경우 = *타임리프나 jsp를 쓰는경우에 사용

*타임리프 사용
그레이들에 타임리프 의존성을 추가하면 뷰의 기본 경로가 main/resources/templates 로 설정된다
➝ 알맞은 View를 찾는 과정에서 return값이 string이면 ThymeleafViewResolver에 의해 view name으로 인식된다

---

📖 @RestController

@RestController
public class ResponseController {

    @RequestMapping("/string")
    public String example() {
        // logic
        return "sparta"; // ViewName이 return 되는게 아니라, String Data가 반환된다.
    }
    
}

• 응답할 Data가 있는 경우에 사용
• 현재는 대부분 이것을 사용해 API가 만들어진다 (Restful API)
  ➝ *return 값으로 View를 찾는 것이 아니라 HTTP Message Body에 Data를 입력한다

*알맞는 View를 찾고 View Resolver한테 가는게 아니라! 바로 데이터를 반환한다
(화면이 그려지는게 아니라 데이터가 나온다)

---

▪️Annotation 자세히 보기▪️

---

📖 @Conponent

• 스프링 빈에 등록하는 역할 = 서블릿 컨테이너와 비슷한 역할
  *빈? 애플리케이션의 구성요소를 정의하는 객체

💡 @Indexed

• 하위 클래스가 스프링 빈에 더 빠르게 등록되도록 도와준다

---

📖 @Target

• 하위 어노테이션이 어떤 범위에 적용되는지 설정
• 엘리먼트 타입의 이넘으로 속성을 설정..

---

📖 @Retention

• 하위의 어노테이션이 얼마나 오래 유지되는지를 설정

1. SOURCE
   • 소스 코드(.java)에서만 유지
   • 컴파일러에 의해 클래스 파일로 저장되지 않는다
2. CLASS
   • 컴파일된 클래스 파일(.class)에 저장되지만, JVM이 실행 시 읽지 않는다(주석과 같음)
   • Default 값임
3. RUNTIME
   • 클래스 파일(.class)에 저장되고, JVM에 의해 런타임 시점에 읽을 수 있다
   • 즉, 실제 런타임 시점의 코드에 반영되어 영향을 준다

---

📖 @Documented

• 문서화 도구에 의해 문서화되어야 함을 나타냄

---

▪️Request Mapping▪️

---

1️⃣ Request Mapping

💡 특정 URL로 요청을 보내면, 그 요청과 컨트롤러 내부의 특정 메서드를 연결 / 매핑함
(실제로는 여러요소를 조합해 매핑한다)

✔️ 사용예시

@RequestMapping(value = "/v1", method = RequestMethod.GET)

• 버전 별로 선언 방식 다르다! ➝ 현재는 맨 뒤에 슬래시 없어야한다

• 속성값들을 설정할때 배열형태로 선언하면 다중설정이 가능하다

• 기본적으로 모든 Http 메서드를 허용한다 (메서드 속성 설정 안했을때)

• 메서드 속성으로 따로 지정을 해버리면 지정된 것만 허용도 가능

     // HTTP Method 는 GET만 허용한다.
     @RequestMapping(value = "/v1", method = RequestMethod.GET)
     public String exampleV1() {
         // logic
      return "this is sparta!";
     }

2️⃣ @GetMapping

✔️ 사용예시

@GetMapping(value = "/v2")

• method = {RequestMethod.GET} 이 설정되어 있는 클래스
• POST, PUT, PATCH, DELETE 모두 사용가능 !
• @RequestMapping 보다 직관적이므로 주로 사용한다

@GetMapping(value = "/v2")
public String exampleV2() {
	// logic
	return "this is sparta!";
}

📌 @RequestMapping 을 사용하는 경우

	@PostMapping, @PutMapping, @DeleteMapping, @PatchMapping	@RequestMapping
Target	Method Level	Class Level, Method Level

• 예시 : users/{userId}, category/{categoryId}/product/{productId}
  prefix로 선언할 URL을 class 레벨에 적용하는 것에 주로 사용

---

3️⃣ @PathVariable

💡 경로 변수임, 비연결성을 극복하기 위함
URL로 전달된 값을 파라미터로 받아온다

✔️ 사용예시

user/{id}

• 경로 변수를 중괄호에 둘러 싸서 사용
• 반드시 경로변수 값을 가져야한다!
• Restful API 설계를 위해 사용빈도가 높아지고 있음

1️⃣ 파라미터 변수명과 PathVariable 변수명이 같으면 생략 가능

[생략전❌]

@RequestMapping("/posts")
@RestController
public class PathVariableController {
	
	// postId로 된 post 단건 조회
	@GetMapping("/{postId}")
	public String pathVariableV1(@PathVariable("postId") Long data) {
		// logic
		String result = "PathvariableV1 결과입니다 : " + data;
		return result;
	}
}

---------------

[생략후⭕️]

@RequestMapping("/posts")
@RestController
public class PathVariableController {
	
	// 변수명과 같다면 속성값 생략가능
	@GetMapping("/{postId}")
	public String pathVariableV2(@PathVariable Long postId) {
		// logic
		String result = "PathvariableV2 결과입니다 : " + postId;
		return result;
	}
	
}

2️⃣ @PathVariable 다중 사용 가능

[1개 사용]

@RestController
public class PathVariableController {
	
	@GetMapping("/{postId}/comments/{commentId}")
	public String pathVariableV3(
								@PathVariable Long postId,
           					    @PathVariable Long commentId
                                 ) {
		// logic
		String result = "PathvariableV3 결과입니다 postId : " + postId + "commentsId : " + commentId;
		return result;
	}
	
}

---------

[다중 사용]

@RequestMapping("/posts/{postId}")
@RestController
public class PathVariableController {
	
	@GetMapping("/comments/{commentId}")
	public String pathVariableV4(
    							@PathVariable Long postId,
                                @PathVariable Long commentId
                                ) {
		// logic
		String result = "PathvariableV4 결과입니다 postId : " + postId + "commentsId : " + commentId;
		return result;
	}
	
}

---

4️⃣ Request Parameter

💡 요청과 속성의 파라미터를 매핑할 수 있음

📌 1. 특정 파라미터와 매핑하기

✔️ 사용예시

@GetMapping(value = "/users", params = "gender=man")

(요청 :URL GET http://localhost:8080/users?gender=man )

✔️ 규칙

1. params = "gender"

   • params의 key값은 커스텀이 가능하다
   • value는 없어도 된다.

2. params = "!gender"

   • gender가 없어야 한다는 의미

3. params = "gender=man"

   • gender=man 이어야 한다는 의미

4. params = "gender!=man"

   • params의 value값이 man가 아니여야 한다는 의미

5. params = {"gender=man", "gender=woman"}

   • 배열로 속성 값을 여러 개 설정이 가능

   ---

📌 2. 특정 헤더와 매핑하기

✔️ 사용예시

@PostMapping(value = "/users", headers = "Content-Type=application/json")

• 특정 헤더와 매핑할 수 있다

• 속성 작성 규칙은 위 params 속성 값의 규칙과 같다

  ---

📌 3. MediaType 매핑, consume(수용)

✔️ 사용예시

@PostMapping(value = "/users", consumes = "application/json")

• 🌟HTTP Header Content-Type(요청)과 매핑
• consumes 값은 //MediaType.APPLICATION_JSON_VALUE
• 최대한 MediaType의 Enum을 사용해라!

✔️ 규칙

1. consumes=”application/json”

   • application/json 미디어 타입 허용

2. consumes=”!application/json”

   • application/json 제외 미디어 타입 허용

3. consumes=”application/*”

   • application/ 으로 시작하는 모든 미디어 타입 허용

4. consumes=”*\/*”

   • 모두 허용

   ---

📌 4. MediaType 매핑, produces(제공)

✔️ 사용예시

@GetMapping(value = "/users", produces = "text/plain")

• 🌟요청 헤더의 Accept 값에 따라서 produces 하는 값이 변함
• 최대한 MediaType의 Enum을 사용해라!

---

📖 Spring이 지원하는 파라미터

• @Controller의 사용 가능한 파라미터 목록

• @Controller의 사용 가능한 Response 값 목록

📌 Http 헤더 조회하기

[예시]

// 로깅
@Slf4j
@RestController
public class RequestHeaderController {

    @GetMapping("/request/headers")
    public String headers(
            HttpServletRequest request, // Servlet에서 사용한것과 같음
            HttpServletResponse response, // Servlet에서 사용한것과 같음
            @RequestHeader MultiValueMap<String, String> headerMap,
            @RequestHeader("host") String host,
            @CookieValue(value = "cookie", required = false) String cookie,
            HttpMethod httpMethod,
            Locale locale
    ) {
		    // Servlet
        log.info("request={}", request);
        log.info("response={}", response);
        
        // @RequestHeader
        log.info("headerMap={}", headerMap);
        log.info("host={}", host);
        
        // @CookieValue
        log.info("cookie={}", cookie);
        
        // HttpMethod
        log.info("httpMethod={}", httpMethod);
        
        // Locale
        log.info("Locale={}", locale);

        return "success";
    }
}

• API 호출
  

• Log 출력 결과