[SpringBoot] Annotation

Intro.Annotation

📌 Annotation 어노테이션 : class와 method에 추가하여 다양한 기능을 부여함

1️⃣ Annotation 활용

• 각 class의 역할선정

• Bean 자동주입

• 자동으로 Getter, Setter 생성

2️⃣ Annotation 장점

• 코드량 감소

• 유지보수 용이

• 생산성 증가

---

대표적인 Annotation과 역할

@Component

개발자가 생성한 class → Spring Bean으로 등록할 때 사용

• 설정정보 없이 자동으로 해당 어노테이션이 붙은 모든 클래스 → Spring Bean 등록

• Spring은 → @Component 어노테이션 보고 → Spring의 Bean으로 등록함

@Component(value="mallang")
public class Family {
    public Mallang() {
        System.out.println("hi");
    }
}

---

@ComponentScan

@Component 스캔 시, @ComponentScan이 붙은 클래스의 패키지가 시작위치

• @ComponentScan이 붙은 class → 프로젝트 최상단에 위치하기

---

@Controller

Spring에게 해당 class가 Controller 역할을 한다고 명시함

• 해당 class에서 URL Mapping 된 method → return 값으로 viewName(String) 반환함

@Controller // 컨트롤러 역할을 하는 클래스
@RequestMapping("/user") // 해당 URL로 들어오는 모든 요청을 처리함
public class UserController {
    @RequestMapping(method = RequestMethod.GET)
    public String getUser(Model model) {
        //  GET method, /user 요청을 처리
    }
}

---

@RequestMapping

Request한 URL과 어노테이션 value 값 일치 → 해당 class 내 method 실행

• @RequestMapping(value = "")

• Controller 객체 안의 method 및 class에 적용가능

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping(method = RequestMethod.GET)
    public String getUser(Model model) {
        //  GET method, /user 요청을 처리
    }
    
    @RequestMapping(method = RequestMethod.POST)
    public String addUser(Model model) {
        //  POST method, /user 요청을 처리
    }
    
    @RequestMapping(value = "/info", method = RequestMethod.GET)
    public String addUser(Model model) {
        //  GET method, /user/info 요청을 처리
    }
}

---

@RequestHeader

Request의 Header 값을 가져옴

• Request Header : 추가데이터, 메타데이터 (의사표현을 위한 데이터)

• 해당 어노테이션을 쓴, 메서드의 파라미터에 사용

• @RequestHeader(value = "")

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping(method = RequestMethod.GET)
    public String getUser(@RequestHeader(value="Accept-Language") String acceptLanguage) {
        //  GET method, /user 요청을 처리
    }
}

---

@PathVariable

URL을 통해 전달된 값 → 파라미터로 받아옴

• RESTful 방식으로 REST 통신에 사용

• @RequestMapping 어노테이션 값으로 {템플릿변수} 사용

• @PathVariable 어노테이션 사용 → {템플릿변수}와 동일한 이름을 갖는 파라미터 추가

📍 localhost:8080/userId값/memo값

@RestController
public class TestController() {
	@RequestMapping("/{userId}/{memo})
	public String test(@PathVariable("userId") String userId, @PathVariable("memo") String memo)
	// 변수 userId, memo에 파라미터값(=URL 전달값)이 할당됨
	return "Test 완료"
	}
}

---

@RequestParam

URL에 전달되는 파라미터 → 메서드 인자와 매칭하여 파라미터를 받아 처리할 수 있는 어노테이션

• 쿼리스트링, GET방식

• JSON 형태의 Body → Message Converter를 통해 Java 객체로 변환시킴

• localhost:8080/param?userId=입력값&memo=입력값

• 특수문자 및 구분점 포함 값이 잘리거나 비정상적으로 들어옴

• GET방식 Request → URL에 값 표출됨

• POST방식 Request → URL에 값 표출 ❌

📍 https://naver.com?nickname=dog&old=10

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping(method = RequestMethod.GET) // GET 방식 선언
    public String getUser(@RequestParam String nickname, @RequestParam(name="old") String age {
        // GET method, /user 요청을 처리
        String sub = nickname + "_" + age;
        ...
    }
}

---

@RequestBody

Body에 전달되는 데이터 → 메서드 인자와 매칭하여 데이터를 받아 처리할 수 있는 어노테이션

• Client가 보내는 HTTP Request 본문 (JSON 등) → Java 객체로 변환

• ① Client 입력값 → HTTP Body에 JSON 형태로 넘어감

• ② 파라미터에 @RequestBody + 값을 받아올 객체 지정해줌

• 객체 필드값 - 파라미터 필드값 정확하게 일치해야함

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping(method = RequestMethod.POST)
    public String addUser(@RequestBody User user) {
        //  POST method, /user 요청을 처리
        String sub_name = user.name;
        String sub_old = user.old;
    }
}

---

@ModelAttribute

Client가 전송하는 HTTP parameter, Body 내용 → Setter 함수 → 1 : 1로 객체에 데이터를 연결함

• @RequestParam or @PathVariable처럼 파라미터 변수 하나당 하나씩 적기 너무 많을 때 → 한번에 가져옴

• 객체에 데이터를 담음

• 객체에 @Setter 첨부 필수

• 파라미터의 @ModelAttribute는 생략가능

• @RequestBody가 Json을 받는 것과 달리, @ModelAttribute는 Json을 받을 수 없음

@PostMapping("/form/model")
    @ResponseBody
    public String helloRequestBodyForm(@ModelAttribute Star star) {
		// ModelAttribute 사용 -> 한번에 데이터를 다 가져옴
        // 객체형식으로 받아서 가져옴
        return String.format("Hello, @RequestBody.<br> (name = %s, age = %d) ", star.name, star.age);
    }

---

@ResponseBody

메서드 리턴 값 → View로 출력 ❌

• HTTP Response Body에 직접 쓰여짐

• return → Json, xml 데이터를 반환함

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping(method = RequestMethod.GET)
    @ResponseBody
    public String getUser(@RequestParam String nickname, @RequestParam(name="old") String age {
        // GET method, /user 요청을 처리
        // https://naver.com?nickname=dog&old=10
        User user = new User();
        user.setName(nickname);
        user.setAge(age);
        return user;
    }
}

---

@Autowired

Spring 프레임워크에서 Bean 객체를 주입받기 위한 방법

	Bean 객체주입 방법
1	@Autowired 어노테이션
2	@AllArgsConstructor 생성자
3	setter

---

@GetMapping

RequestMapping(Method=RequestMethod.GET)와 같은 역할

@Controller
@RequestMapping("/user")
public class UserController {
    @GetMapping("/")
    public String getUser(Model model) {
        //  GET method, /user 요청을 처리
    }
    
    ////////////////////////////////////
    // 위와 아래 메소드는 동일하게 동작합니다. //
    ////////////////////////////////////

    @RequestMapping(method = RequestMethod.GET)
    public String getUser(Model model) {
        //  GET method, /user 요청을 처리
    }
}

---

@PostMapping

RequestMapping(Method=RequestMethod.POST)와 같은 역할

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping(method = RequestMethod.POST)
    public String addUser(Model model) {
        //  POST method, /user 요청을 처리
    }

    ////////////////////////////////////
    // 위와 아래 메소드는 동일하게 동작합니다. //
    ////////////////////////////////////

    @PostMapping('/')
    public String addUser(Model model) {
        //  POST method, /user 요청을 처리
    }
}

---

@RequiredArgsConstructor

final, @Notnull이 붙은 필드의 생성자를 자동으로 만들어줌

• 원래 의존성 주입 → 생성자, Setter, Field 타입의 방식사용

• Lombok의 @RequiredArgsConstructor 어노테이션 사용

@Service
@RequriedArgsConstructor // final 붙은 필드 -> 생성자 자동으로 붙여줌
public class TestService {
	private final TestRepository1 testRepository1; // final -> 상수
	private final TestRepository2 testRepository2;
}

---

@EntityListeners

Entity 변화감지 → 테이블 데이터 조작

• Column값이 자동으로 수정됨

---

@Id

primary key (기본키_데이터 중복을 막음) 변수 선언

• JPA에서 Entity 객체 정의 시, @Id 속성을 함께 정의해야함

💡 직접할당하는 방법

• @Id 어노테이션만으로 Id를 지정함

💡 자동생성

• @Id와 @GeneratedValue 같이 사용

• GenerationType 옵션으로 전략을 지정함

📍 TABLE
	- 특정 벤더에 의존적이지 않음
    - 시퀀스 테이블 → 데이터베이스 시퀀스를 흉내낼 Id 할당

📍 IDENTITY
	- PK (기본키) 생성을 DB에게 위임 (MySQL = AUTO INCREMENT)
    - 특정 DB 벤더에 의존적임

📍 SEQUENCE
	- DB의 sequence 객체 이용 → 유일한 값을 순서대로 생성
    - 특정 DB 벤더에 의존적임

📍 AUTO
	- DB벤더에 따라 자동으로 3가지 전략 중 하나를 선택함
    
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)

---

@Column

객체필드(변수)와 DB column을 맵핑함

💡 속성

• name : 맵핑할 테이블의 컬럼이름을 지정

• insertable : 엔티티 저장 시 선언될 필드도 같이 저장

• updateable : 엔티티 수정 시 이 필드를 함께 수정

• table : 지정한 필드를 다른 테이블에 맵핑

• nullable : null을 허용할지, 허용하지 않을지 결정

@Column(nullable = false) // null 허용 안함
	private String memberName;

• unique : 제약조건을 걸 때 사용

• length : varchar의 길이를 조정함 (기본값 255)

---

Lombok Annotation

📌 Lombok : 코드를 크게 줄여, 가독성을 크게 높여주는 라이브러리

• @Setter : class 모든 필드의 Setter method를 생성

• @Getter : class 모든 필드의 Getter method를 생성

• @AllArgsConstructor : class 모든 필드 값을 파라미터로 받는 생성자를 추가함

• @NoArgsConstructor : class 기본생성자를 자동으로 추가해줌

• @ToString : class 모든 필드의 toString method를 생성함