영속성 컨텍스트 : "엔티티를 영구 저장하는 환경"

  • Server side와 Database 사이에 엔티티를 저장하는 논리적인 영역
  • 엔티티 매니저로 엔티티를 저장하거나 조회하면 엔티티 매니저는 영속성 컨텍스트에 엔티티를 보관하고 관리한다.
  • 눈에 보이지 않는 논리적인 개념
  • 엔티티 매니저를 통해 영속성 컨텍스트에 접근
EntityManager.persist(entity);

 

준영속 엔티티

  • 영속성 컨텍스트가 더는 관리하지 않는 엔티티
  • 임의로 만들어낸 엔티티도 기존 식별자를 가지고 있으면 준영속 엔티티로 볼 수 있음

준영속 엔티티의 문제: JPA가 관리를 안함, 변경을 해도 update가 안됨

 

준영속 엔티티를 수정하는 2가지 방법

  1. 변경 감지 기능 사용
  2. 병합(merge) 사용
    • 준영속 상태의 엔티티를 영속 상태로 변경할 때 사용하는 기능
    • 넘어온 모든 데이터를 바꿔치기 함

Merge 병합

public void save(Item item){
  if (item.getId()==null){
    em.persist(item);
    }
  else{
    Item merge=em.merge(item);
    }
  }

 

 

Merge 시 주의사항

  • 변경 감지 기능을 사용하면 원하는 속성만 선택해 변경이 가능하지만, 병합을 사용하면 모든 속성이 변경됨
  • 병합시 값이 없으면 null로 업데이트 할 위험 존재 (병합은 모든 필드를 교체)
  • 실무에서는 보통 변경가능한 데이터만 노출하기 때문에, 병합을 사용하는 것이 더 번거롭다.
  • Merge보다는 변경 감지 기능을 사용하는 것이 더 낫다.
  • 변경감지 기능을 사용할 때 setter를 사용하면 추적하기 어려우므로 setter 보다는 메소드를 활용

JWT 토큰 인증 방식은 프론트 쪽에서 구글 인증 및 access token을 발급받고, 백엔드에 요청을 보낼 때 구글에서 받은 사용자 정보를 JWT 토큰으로 암호화하여 토큰을 활용해 현재 유저를 식별하도록 하였다.

 

카카오/구글 모두 access token으로 사용자 정보를 조회할 수 있다. access token은 일회성이라 한번 사용했다면 다시 재발급을 받아야 한다.

Client : 커뮤니티 서비스

Resource Owner : 사용자

Service Provider : 구글, 카카오, 페이스북 

 

1. Service Provider에 Client 정보 등록

Redirect URI

Service Provider가 Client에게 Access Token과 토큰을 발급받기 위해 Authentication Code를 전해주는 경로

 

2. Client의 인증 요청 & 권한 부여 요청

사용자가 Client의 회원가입 페이지로 이동하여 구글로 가입하기를 선택하면

Client는 Authroization Server에 인증을 요청한다.

Service Provider는 두개의 서버가 있는데, 인증 및 권한 부여를 담당하는 Authorization Server(인증 서버)와 사용자의 데이터를 관리하는 Resource Server(리소스 서버)가 있다.

 

  권한 인증을 요청할 때는 처음에 등록한 Client Id와 사용할 리소스의 범위를 나타내는 Scope, 그리고 Resource Owner의 리소스 사용 승인 시 임시 토큰인 Authorization Code를 전달할 Redirect Url을 함께 파라미터로 넘겨준다.

 예를 들어 Client Id가 test, 접근할 정보가 email, name이고 redirect url은 /myserivce/auth/success라고 하면,

쿼리 스트링으로 https://auth.google.com/profile?clientId=test&scope=email,name&redirect_url=/myserivce/auth/success

이런식으로 보여진다.

그러면 Service Provider에서는 Resource Owner가 로그인하여 리소스 사용을 승인할 수 있는 페이지로 302 응답을 통해 Resource Owner를 이동시킨다.

이 페이지는 Client가 사용할 권한 목록을 Resource Owner에게 명시적으로 보여주며, Resource Owner는 이에 동의 시 "나는 Client가 Scope에 명시한 범위 안에 있는 내 데이터에 접근할 권한을 부여하는 것에 동의합니다"라고 말하는 것과 같다.

 

3. Access Token 발행 요청

Client는 서비스 제공자에게 Client Id와 Secret Key, Access Token이 발행되면 아까 Authentication Code를 발급 받을때 사용했던 Redirect Url, 그리고 아까 Resource Owner에게 받은 인가 코드를 가지고 Access Token을 발행 요청을 한다.

서비스 제공자의 인증 서버는 리소스에 접근할 수 있는 Access Token과 Refresh Token을 발행하고 Client에게 보내준다.

 

4. 리소스에 접근 요청

Access Token을 받고 Client는 이 토큰을 통해 Resource Server에서 사용자의 정보에 접근한다.

Access Token이 저장된 DB에 비교하여 지정된 Scope에 접근하는 게 맞는지 확인 후 돌려준다.

보통 헤더에 많이 세팅한다.

 

5. Access Token 재발급 요청

시간이 지나서 Access Token이 만료된다면 좀 전에 말했듯이 Refresh Token을 통해 새로 발급받을 수 있다.

Access Token을 발급받을 때 보통 expires라는 항목으로 유효시간이 같이 넘어오는데, 이를 통해 유효시간이 지났는지 확인할 수 있고 지났으면 Refresh Token으로 재발급받는다.

 

🍀 구글 OAuth API 프로젝 환경 구성

 구글 API를 사용하기 위해서는 우선 하단의 사이트에서 일련의 구성및 허가 과정을 거쳐야 한다.

 

Google 클라우드 플랫폼

로그인 Google 클라우드 플랫폼으로 이동

accounts.google.com

프로젝트를 생성 후, OAuth 클라이언트 ID를 만들어서 생성된 클라이언트 ID와 비밀코드를 따로 보관한다.

유출되지 않도록 유의하기!

 

 

 

웹 서버 애플리케이션용 OAuth 2.0 사용  |  Authorization  |  Google Developers

이 페이지는 Cloud Translation API를 통해 번역되었습니다. Switch to English 의견 보내기 웹 서버 애플리케이션용 OAuth 2.0 사용 컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분

developers.google.com

클라이언트 페이지에서 구글 인증 서버로 인증 코드 발급 요청을 보낼 URL에 링크를 건다. 요청을 받는 엔드포인트는 https://accounts.google.com/o/oauth2/v2/auth 이며 상단의 파라미터들을 쿼리스트링으로 만들어, GET 요청으로 전달해야 한다.

access_type값의 경우 offline으로 넘겨야 refresh token이 발급된다.

추가로 사용할 Scope은 email, profile, openid를 설정한다. 

인증 코드를 발급받을 때 넘기는 scope 파라미터에 지정을 해두지 않으면 값이 넘어오지 않는다.

 

사용자가 아이디를 선택해 로그인하면 인증 코드가 발급된다.

인증 코드는 인증 서버를 호출한 클라이언트를 거쳐 다시 서버로 전달되어 아까 인증코드를 요청할때 함께 넘겼던 redirect url로 요청된다.

 

뒤이어 계속..

@Autowired 

객체 생성을 스프링에서 자동으로 생성해주는 역할

주입하려 하는 객체의 타입이 일치하는 객체를 자동으로 주입

 

IoC (Inversion of Control) 제어의 역전

메소드나 객체의 호출작업을 개발자가 정하는 것이 아닌 외부에서 정하는 것

 

DI (Dependency Injection) 의존관계 주입

객체를 직접 생성하는 게 아니라 외부에서 생성한 후 주입 시켜주는 방식

Spring에서 컨트롤러를 지정해주기 위한 어노테이션은 @Controller와 @RestController가 있다.

전통적인 Spring MVC의 컨트롤러인 @Controller와 Restuful 웹서비스의 컨트롤러인 @RestController의 주요한 차이점은 HTTP Response Body가 생성되는 방식이다.

 

 

근본적인 차이는 @Controller의 역할은 Model 객체를 만들어 데이터를 담고 View를 찾는 것이지만, @RestController는 단순히 객체만을 반환하고 객체 데이터는 JSON 또는 XML 형식으로 HTTP 응답에 담아서 전송한다.

 

@Controller은 뷰에 표시될 데이터가 있는 Model 객체를 만들고 올바른 뷰를 선택하는 일을 담당한다.

또한, @ResponseBody를 사용하여 HTTP Response Body에 데이터를 담아 요청을 완료할 수 있다.

HTTP Response Body에 데이터를 담는 것은 RESTful 웹 서비스에 대한 응답에 매우 유용한데, 뷰를 반환하는 대신 데이터를 반환하기 때문이다.

 

하지만 @RestController을 사용하여 동일한 기능을 제공할 수 있다.

요컨대 @Controller와 @ResponsBody의 동작을 하나로 결합한 편의 컨트롤러라 보면 된다.

 

다음 두 코드는 Spring MVC에서 동일한 동작을 한다.

@Controller
@ResponseBody
public class MVCController{
	logic...
}

@RestController
public class ReftFulController{
	logic...
}

대부분의 개발자들은 두개의 어노테이션이 아닌 하나의 어노테이션만 선언하고 싶어할 것이다.

또한, @RestController는 이전 두개보다 의미에 대해서 명확히 나타내고 있다.

 

 

@RestController vs @Controller

1. @Controller는 클래스를 Spring MVC 컨트롤러로 표시하는데 사용되며 @RestController는 RESTful 웹 서비스에서 사용되는 특수 컨트롤러이다. @Controller + @ResponseBody와 동일하다.

 

** RESTful 웹서비스란 : url을 통해 데이터를 요청하고 그 데이터는 XML 형식으로 반환

출처 : https://kimseunghyun76.tistory.com/18

 +) REST 의 특징

 1) REST 방식의 웹서비스는 잘 정의된 Cool URI로 리소스를 표현.

무분별한 파라미터의 남발이 아닌 마치 오브젝트의 멤버 변수를 따라가듯이 정의

 

 

 2) REST 방식의 웹서비스는 세션을 쓰지 않는다.

  기존의 서블릿 개발에서는 세션을 이용해서 인증 정보를 가지고 다니는데 요청 처리가 매우 무거워진다. 그리고 요청의 전후 관계에 관련성이 생기기에 한 세션의 일련의 요청을 하나의 서버가 처리해야 한다. 하지만 REST는 세션을 사용하지 않기에 각각의 요청이 완벽하게 독립적이다.

 

 

  3) REST란 4가지 속성을 지향하는 웹서비스 디자인 표준이다.

  ROA는 웹의 모든 리소스를 URI로 표현하고, 모든 리소스를 구조적이고 유기적으로 연결하여 비 상태 지향적인 방법으로 정해진 method만을 사용하는 아키텍쳐다.

 

  * Addressablilty (주소로 표현 가능함)
 - 제공하는 모든 정보를 URI로 표시할 수 있어야 한다.

 

  * Connectedness (연결됨)
 - 일반 웹 페이지처럼 하나의 리소스들은 서로 주변의 연관 리소스들과 연결되어 표현(Presentation)되어야 한다.

 

  * Statelessness (상태 없음)
 - 현재 클라이언트의 상태를 절대로 서버에서 관리하지 않아야 한다.(REST에서는 상태가 서버가 아니라 클라이언트에 유지되며 매 요청마다 필요한 정보를 서버에 보낸다.)
 - 모든 요청은 일회성의 성격을 가지며 이전의 요청에 영향을 받지 말아야 한다.
 - 세션을 유지 하지 않기 때문에 서버 로드 밸런싱이 매우 유리하다.
 - URI에 현재 state를 표현할 수 있어야 한다. (권장사항)

 

  * Homogeneous Interface (동일한 인터페이스)
 - HTTP에서 제공하는 기본적인 4가지의 method와 추가적인 2가지의 method를 이용해서 리소스의 모든 동작을 정의한다.
 - 대부분의 리소스 조작은 6가지의  method를 이용하여 대부분 처리 가능하다. 만일 이것들로만 절대로 불가능한 액션이 필요할 경우에는 POST를 이용하여 추가 액션을 정의할 수 있다. (되도록 지양하자)

REST는 웹의 모든 리소스를 URI로 표현하고 이를 구조적이고 유기적으로 연결하여 비 상태 지향적인 방법으로 일관된 method를 사용하여 리소스를 사용하는 웹 서비스 디자인 표준이다.

 

 

 

2. @RestController는 Spring 4.0에서 추가되었지만, @Controller는 Spring이 주석을 지원하기 시작한 이후에 존재하며 공식적으로 Spring 2.5 버전에서 추가되었다.

 

3. @Controller는 @Component 주석이 달려있고 @RestController는 아래와 같이 @Controller와 @ResponseBody 주석이 달린 편의 컨트롤러이다.

 

@Target(value=TYEP)
@Retention(value=RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController
@Target(value=TYEP)
@Retention(value=RUNTIME)
@Documented
@Component
public @interface Controller

 

4. 주요 차이점 중 하나는 @RestController을 표시하면 모든 메소드가 뷰 대신 객체로 작성된다!

일반적인 Spring MVC 처리 과정

 

위 사진에서 볼 수 있다싶이 @RestController를 클래스에 달면 모든 핸들러 메소드에서 @ResponseBody를 사용할 필요가 없다!

 

@Controller
@RequestMapping("books")
public class SimpleBookController {

    @GetMapping("/{id}", produces = "application/json")
    public @ResponseBody Book getBook(@PathVariable int id) {
        return findBookById(id);
    }

    private Book findBookById(int id) {
        // ...
    }
}
@RestController
@RequestMapping("books-rest")
public class SimpleBookRestController {
    
    @GetMapping("/{id}", produces = "application/json")
    public Book getBook(@PathVariable int id) {
        return findBookById(id);
    }

    private Book findBookById(int id) {
        // ...
    }
}

 

 

결론은 REStful 웹 서비스를 만드는 경우 @Controller + @ResponseBody를 사용하는 것보다 @RestController을 사용하는 것이 좋다!

 

ref: https://kimseunghyun76.tistory.com/18, https://dncjf64.tistory.com/288

Spring Container

자바 애플리케이션은 애플리케이션 동작을 제공하는 객체들로 이루어져있다.

이때, 객체들은 독립적으로 동작하는 것보다 서로 상호작용하여 동작하는 경우가 많은데

이렇게 상호작용하는 객체를 '객체의 의존성'이라고 표현

 

스프링에서는 스프링 컨테이너가 객체들을 생성하고 객체끼리 의존성을 주입하는 역할을 함.

프링 컨테이너가 생성한 객체들을 '빈'이라고 한다.

즉, 빈은 스프링에서 사용하는 어플리케이션 객체라고 이해할 수 있다.

 

빈의 생성 방법

1. xml 활용

  컴파일 단계에서 스캔하는 xml에 bean을 명시적으로 입력해줌

2. 어노테이션 활용

  xml 통해 빈을 생성하는 건 상당히 번거롭

  @Component 라는 어노테이션을 지정하여 편리하게 빈 생성

  (@Component는 스프링 컴포넌트 클래스를 지정하는 어노테이션)

 

 

의존성 주입

Spring Framework의 3가지 핵심 프로그래밍 모델 중 하나

외부에서 두 객체 간 관계를 정해주는 디자인패턴으로 인터페이스를 사이에 두고 클래스 레벨에서는 의존 관계가 고정되지 않도록 함

런타임시 관계를 동적으로 주입하여 결합도를 낮출 수 있게 하는 기법

 

DI (Dependency Injection)

의존성 주입은 IoC(Invesoin of Control, 의존성 역전) 원칙 하에 객체 간 결합을 약하게 해주고 유지보수가 좋은 코드를 만들어 줌

-> 즉 외부에서 생성된 객체를 이용

 

한 객체가 어떤 객체에 의존할것인지는 별도의 관심사이다.

DI컨테이너를 통해 서로 강하게 결합되어있는 두 클래스를 분리하고,

두 객체간 관계를 결정해줌으로서 결합도를 낮추고 유연성을 확보하고자 한다.

(이때 다른 빈을 주입받으려면 자기자신도 반드시 컨테이너의 빈이여야 한다.)

 

강한 결합

객체 내부에서 다른 객체를 생성하는 것은 강한 결합도를 가지는 구조이다

클래스 간 관계가 맺어질 땐 근본적으로 의존성 주입을 통해 문제를 해결할 수 있음

-> 다형성 필요 (큰 범주의 Interface가 필요하고, 그 범주의 Interface를 구현하는 구현 클래스를 만들면 된다!)

  그 후 상세 클래스에서 외부에서 해당 구현 클래스를 주입받도록 한다

ex) 배터리(의존 객체)를 사용하는 장난감(어떤 객체)에게 배터리를 넣어주는 것을 의존성 주입이라고 생각하면 된다!

애플리케이션 실행시점에 필요한 빈을 생성하여, 의존성이 있는 두 객체를 연결하기위해 한 객체를 다른 객체로 주입시켜줘야 한다.

 

느슨한 결합

객체를 주입받는다는 것은 외부에서 생성된 객체를 인터페이스를 통해 넘겨받는 것

이렇게 하면 런타임시 의존관계가 결정되어 결합도를 낮출 수 있다!

 

스프링의 의존성 주입

만약 Service와 Repository가 둘다 Bean(*스프링 컨테이너 상에서 생성된 객체)으로 등록되어 있다면, Service의 생성자만 만들어주면 스프링 IoC컨테이너가 Repository에 의존성을 알아서 해준다. 

(*컨테이너 : 쉽게말해 bean객체들이 들어있는 통)

 

스프링은 다양한 의존성 주입방법을 제공한다.

@Autowired 어노테이션을 이용하면  Spring에게 의존성을 주입하라 라고 명령하는것과 같은데 생성자, 필드, 세터에 붙일수 있다.

 

1.  생성자 주입 (가장 권장)

생성자에 @Autowired를 붙여 의존성을 주입받을 수 있음

 

생성자주입은 생성자 호출시점에 (해당클래스의 인스턴스생성시) 1회 호출되는 것이 보장

-> 주입받은 객체가 변하지 않거나, 반드시 객체주입이 필요한 경우에 강제하기 위해 사용된다.

 

가장 권장하지만 생성자 주입을 위해 코드를 만드는 부분에서 번거로움 존재

그래서 많이들 사용하는 Lombok에서 @Getter, @Setter 어노테이션처럼 @RequiredArgsConstructor 어노테이션은 클래스에 선언된 final 변수들, 필드들을 매개변수로 하는 생성자를 자동으로 생성해주는 어노테이션이다

 

2. 필드 주입

멤버변수 선언부에 @Autowired을 붙인다.

 

필드주입을 이용하면 코드가 간결해져서 과거에 많이 사용했던 방법이다.

하지만 필드 주입은 외부에서 변경이 불가능하다.

(테스트코드의 중요성이 부각됨에 따라 필드의 필드객체를 수정할 수 없는 필드주입은 거의 사용하지 않게 됨)

또한 필드주입은 반드시 DI 프레임워크가 존재해야 하므로 사용을 지양해야한다!

 

3. Setter주입

Setter메소드에 @Autowired을 붙인다.

 

필드값을 변경하는 Setter를 통해서 의존관계를 주입하는 방법이다.

Setter주입은 생성자 주입과 달리 주입받는 객체가 변경될 가능성이 있는 경우에 사용한다. 

 

 

생성자를 통한 주입을 사용해야 하는 이유

Spring에서 가장 권장하는 방법은 생성자를 통한 주입이다.

 

1. 생성자를 사용하면 필수적으로 사용해야 하는 의존성 없이는 인스턴스를 만들지 못하도록 강제 가능

만약 SampleController가 SampleRepository없이는 제대로 동작할 수 없다면 SampleController에서 생성자를 통해 강제로 SampleRepository를 무조건 주입받은 후에야 인스턴스를 생성할 수 있도록 해야할 것이다. 

 

2. 생성자주입을 통해 변경의 가능성을 배제하고 불변성을 보장할 수 있다.

 

3. final 키워드 작성 및 롬복과의 결합

생성자주입을 사용하면 필드객체에 final키워드를 사용할 수 있다. 이는 컴파일 시점에 누락된 의존성을 확인할수 있다.

반면 생성자 주입을 제외한 다른 주입방법들은 객체생성 이후 (생성자호출이후) 에 호출되므로 final키워드를 사용할 수 없다. ( 객체생성 이후에 필드값을 변하게 하는것이니까!)

 

또한 final키워드를 붙임으로서 Lombok과 결합되어 코드를 더 간결하게 작성할 수 있다.

롬복에는 final변수를 위한 생성자를 대신해주는 @RequiredArgsConstructor가 있다.

 

 

@RequiredArgsConstructor

초기화되지 않은 final 필드나 @NotNull이 붙은 필드에 대해 생성자를 생성

주로 의존성 주입 (Dependency Injection) 편의성을 위해 사용

 

스프링 의존성 주입의 특징 중 한가지를 이용하는데 다음과 같다

어떠한 빈(Bean)에 생성자가 오직 하나만 있고, 생성자의 파라미터 타입이 빈으로 등록 가능한 존재라면 이 빈은 @Autowired 어노테이션 없이도 의존성 주입이 가능하다.

즉 새로운 필드를 추가할 때 다시 생성자를 만들어서 관리해야하는 번거로움을 없애줌!

(@Autowired 사용하지 않고 의존성 주입)

  • Spring Framework의 DI(의존성주입) 중 Constructor Injection(생성자 주입)을 임의의 코드 없이 자동으로 설정
  • @RequiredArgsConstructor이 어떻게 구동하는지 정확히 알아야 예상치 못한 오류를 막을 수 있음

 

추가적으로 롬복 어노테이션이(@Getter 혹은 @Setter 등) 사용할땐 편하지만, 단점도 있다.

setter 메서드가 필요없는 필드에 대해서도 setter 메서드를 강제로 생성하게 되니, 필드 값이 변경될 위험이 생긴다.

이런 부분들은 전부 리팩토링의 대상이지만, 롬복을 사용하게될 경우 리팩토링이 힘들어지는 부분도 있으니 너무 무분별하게 사용하는것은 좋지 않다!

 

 

References : https://esoongan.tistory.com/90, https://medium.com/webeveloper/requiredargsconstructor-%EB%A5%BC-%EC%9D%B4%EC%9A%A9%ED%95%9C-%EC%9D%98%EC%A1%B4%EC%84%B1-%EC%A3%BC%EC%9E%85-dependency-injection-4f1b0ac33561

자바 ORM 표준 JPA 프로그래밍, 하단의 블로그, 김영한의 실전 JPA1을 참고해서 정리한 글입니다!

 

 

[JPA] 엔티티와 매핑. @Entity, @Table, @Id, @Column..

| 엔티티와 매핑 객체와 테이블 매핑 : @Entity, @Table 기본 키 매핑 : @Id 필드와 컬럼 매핑 : @Column 연관관계 매핑 : @ManyToOne, @JoinColumn 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23..

data-make.tistory.com

1. 엔티티

- 테이블과 매핑

- @Entity가 붙은 클래스는 JPA가 관리하는 것으로 엔티티라고 불림

 

* 속성

Name : JPA에서 사용할 엔티티 이름을 지정. 보통 기본값인 클래스 이름 사용

 

* 주의사항

- 기본 생성자는 필수 (JPA가 엔티티 객체 생성 시 기본 생성자 사용)

- final 클래스, enum, interface, inner class에는 사용 불가

- 저장할 필드에 final 사용 불가

 

2. 테이블

- 엔티티와 매핑할 테이블 지정

- 생략시 매핑한 엔티티 이름을 테이블 이름으로 사용

 

* 속성

Name: 매핑할 테이블 이름 (default, 엔티티 이름 사용)

Catalog: catalog 기능이 있는 DB에서 catalog를 매핑 (default, DB명)

Schema: schema 기능이 있는 DB에서 schema를 매핑

uniqueConstraints: DDL 생성 시 유니크 제약 조건을 만듦. 스키마 자동 생성 기능을 사용해서 DDL 만들 때만 사용

 

** 엔티티와 테이블의 차이?

@Entity

- 우선 필수, @Entity만 사용했을 경우 DB와 연결 시 테이블명은 클래스명과 동일하게 설정

  => @Entity 어노테이션을 사용한 상태에서 클래스명이 CrudEntity일 경우 DB에서 CrudEntity 테이블로 연결!

- @Entity(name = "엔티티명")으로 테이블명을 지정해 줄 경우 이후 EntityManager 등을 이용해 쿼리를 사용하는 경우 createQuery("select .. from 엔티티명") 이렇게 사용 가능

 

@Table

- 외부에서 호출하는 용도가 아닌 실제 DB에 붙을 테이블명 어노테이션

- @Entity

@Table(name = "테이블명")

이렇게 지정을 해 놓을 경우 createQuery(select m from 엔티티클래스명) 으로 호출을 해 주면

호출은 엔티티클래스명으로 하지만 실제 DB에는 테이블명의 테이블로 붙게 된다!

 

3. 엔티티 매핑

 

객체와 테이블 매핑 : @Entity, @Table
기본 키 매핑 : @Id
필드와 컬럼 매핑 : @Column
연관관계 매핑 : @ManyToOne, @JoinColumn

 

@Entity
// name과 age Column에 unique 제약조건 추가
@Table(name="MEMBER", uniqueConstraints = {@UniqueConstraint(
		name = "NAME_AGE_UNIQUE",        
        columnNames = {"NAME", "AGE"} )})
public class Member {     

	// 기본키 매핑    
    @Id    
    @Column(name = "ID")    
    private String id;     
    
    // not null, varchar(10)    
    @Column(name = "NAME", nullable = false, length = 10)    
    private String username;     
    
    private Integer age;     
    
    // Java의 enum 사용    
    @Enumerated(EnumType.STRING)    
    private RoleType roleType;     
    
    // Java의 날짜 타입    
    @Temporal(TemporalType.TIMESTAMP)    
    private Date createdDate;     
    
    @Temporal(TemporalType.TIMESTAMP)    
    private Date lastModifiedDate;     
    
    // CLOB, BLOC 타입 매핑    
    @Lob    
    private String description;     
    
    @Transient    
    private String temp;      
    
    //Getter, Setter
} 

public enum RoleType {
	ADMIN, USER
}

 

4. 데이터베이스 스키마 자동 생성

- JPA는 데이터베이스 스키마를 자동으로 생성하는 기능 지원

- 클래스의 매핑 정보와 데이터베이스 방언을 사용하여 데이터베이스 스키마 생성 

애플리케이션 실행 시점에 데이터베이스 테이블을 자동으로 생성

 

hibernate.hbm2ddl.auto 속성

create : 기존 테이블을 삭제하고 새로 생성(DROP + CREATE)

create-drop : CREATE 속성에 추가로 애플리케이션을 종료할 때 생성한 DDL을 제거  (DROP + CREATE + DROP)

update : DB 테이블과 엔티티 매핑 정보를 비교해서 변경 사항만 수정

validate : DB 테이블과 엔티티 매핑정보를 비교해서 차이가 있으면 경고를 남기고 애플리케이션을 실행하지 않음.

DDL을 수행하지 않음

none : 자동 생성 기능을 사용하지 않음

 

주의사항

- 개발 초기 단계는 create 또는 update

- 초기화 상태로 자동화된 테스트를 진행하는 개발자 환경과 CI서버는 create 또는 create-drop

- 테스트 서버는 update 또는 validate

- 스테이징과 운영 서버는 validate 또는 none

 

5. 기본 키 매핑

- 영속성 컨텍스트는 엔티티를 식별자 값으로 구분하므로 엔티티를 영속 상태로 만들기 위해 식별자 값 반드시 필요

 

@GeneratedValue

- 기본 키 생성 전략

  * 직접 할당: 기본 키를 애플리케이션에 직접 할당

  => em.persist()를 호출하기 전 애플리케이션에서 직접 식별자 값을 할당해야 함. 식별자 값이 없을 경우 예러 발생

  * 자동 생성: 대리 키 사용 방식

     1) IDENTITY: 기본 키 생성을 데이터 베이스에 위임 (= AUTO_INCREMENT)

     2) SEQUENCE : 데이터베이스 시퀀스를 사용해서 기본 키를 할당, 데이터베이스 시퀀스에서 식별자 값을 획득한 후 영속성 컨텍스트에 저장함. 유일한 값을 순서대로 생성 (오라클, PostgreSQL, DB2, H2)
    3) TABLE : 키 생성 테이블을 사용키 생성 전용 테이블 하나를 만들고 여기에 이름과 값으로 사용할 컬럼을 만들어

데이터베이스 시퀀스를 흉내내는 전략. 테이블을 사용하므로 모든 데이터베이스에 적용 가능

    4) AUTO : 선택한 데이터베이스 방언에 따라 방식을 자동으로 선택(Default)

  Ex) 오라클 DB 선택 시 SEQUENCE, MySQL DB 선택 시 IDENTITY 사용

 

@Column

- 객체 필드를 테이블 컬럼에 매핑

- 속성 중 name, nullable이 주로 사용되고 나머지는 잘 사용되지 않음

    1) name : 필드와 매핑할 테이블 컬럼 이름 (default. 객체의 필드 이름)

    2) nullable (DDL) : null 값의 허용 여부 설정, false 설정 시 not null (default. true)   @Column 사용 시 nullable = false 로 설정하는 것이 안전

    3) unique (DDL) : @Table 의 uniqueConstraints와 같지만 한 컬럼에 간단히 유니크 제약조건을 적용

    4) columnDefinition (DDL) : 데이터베이스 컬럼 정보를 직접 줄 수 있음, default 값 설정   (default. 필드의 자바 타입과 방언 정보를 사용해 적절한 컬럼 타입을 생성)

    5) length (DDL) : 문자 길이 제약조건, String 타입에만 사용 (default. 255)

    6) percision, scale (DDL) : BigDecimal, BigInteger 타입에서 사용. 아주 큰 숫자나 정밀한 소수를 다룰 때만 사용(default. precision = 19, scale = 2)

 

@Enumerated

 - 자바의 enum 타입을 매핑할 때 사용

   * value : EnumType.ORDINAL : enum 순서를 데이터베이스에 저장

                 EnumType.STRING : enum 이름을 데이터베이스에 저장 (default.EnumType.ORDINAL)

 

@Temporal

 - 날짜 타입(java.util.Date, java.util.Calendar)을 매핑할 때 사용

   * value : TemporalType.DATE : 날짜, 데이터베이스 data 타입과 매핑 (2020-12-18) 

                  TemporalType.TIME : 시간, 데이터베이스 time 타입과 매핑 (23:36:33)

                  TemporalType.TIMESTAMP : 날짜와 시간, 데이터베이스 timestamp 타입과 매핑 (2020-12-18 23:36:33)

                   (default. TemporalType은 필수로 지정)

 

@Temporal 을 생략하면 자바의 Date와 가장 유사한 timestamp로 정의

 

@Lob

 - 데이터베이스 BLOB, CLOB 타입과 매핑

  * 지정 속성이 없음. 대신 매핑하는 필드 타입이 문자면 CLOB, 나머지는 BLOB로 매핑

 

@Transient

 - 이 필드는 매핑하지 않음. 데이터베이스에 저장하지 않고 조회하지도 않음.

 객체에 임시로 어떤 값을 보관하고 싶을 때 사용

 

@Access

 - JPA가 엔티티 데이터에 접근하는 방식 지정

  * 필드 접근 : AccessType.FIELD로 지정, 필드에 직접 접근 (private도 접근 가능)

  * 프로퍼티 접근 : AccessType.PROPERTY로 지정 (접근자 Getter 사용)

 

 

5. 엔티티 설계시 주의점

- 엔티티에는 가급적 Setter 사용 X (Setter가 모두 열려있다 == 변경 포인트가 너무 많아서 유지 보수 어렵다)

 

- 모든 연관 관계는 지연로딩으로 설정! (개중요!!!!!!!! 실제 프로젝트 쓸 때 오류 해결할 때 유용)

  * 즉시로딩(EAGER = 멤버를 조회할 때 연관된 Order 조회를 다 하는 것)는 예측 어렵고 어떤 SQL이 실행될지 추적하기 어렵

  * 실무에서 모든 연관관계는 지연로딩(LAZY)로 설정

  * 문맥상에서 원하는 것만 선택해 가져올 수 있음

  * 연관된 엔티티를 함께 DB에서 조회해야 하면 fetch, join 또는 엔티티 그래프 기능을 사용한다

  * @XToOne 관계는 기본이 즉시로딩이므로 직접 지연로딩으로 설정해야 함

 

- 컬렉션은 필드에서 초기화하자

  * 컬렉션은 필드에서 초기화하는 것이 안전

  * null 문제에서 안전


- 테이블, 컬럼명 생성 전략  (SpringPhysicalNamingStrategy)

  * 스프링부트 신규 설정 (엔티티(필드) -> 테이블(컬럼))

    > 카멜 케이스 => 언더스코어 (memberPoint -> member_point)

    > .(점) => _(언더스코어)

    > 대문자 => 소문자

  * 논리명? => 명시적으로 컬럼, 테이블명을 직접 적지 않으면 ImplicitNamingStrategy 사용

  * 물리명? => 모든 논리명에 적용됨, 실제 테이블에 적용

 

스프링부트 프로젝트의 application.yml을 설정해주었다

datasource의 url로는 db 연결되어있는 주소를 입력하고,

username과 password에는 해당 사용자의 이름, 비밀번호를 입력한다.

 

  • hibernate: ddl-auto : create => 서버 실행할마다 매번 DB를 초기화시킨다는 뜻. 한번 초기화가 이뤄지고 세팅이 완료되면 none으로 바꾸고 실행해주면 된다
  • show_sql: true로 설정하면 개발시에 콘솔에서 로그로 어떤 쿼리가 실행되는지 확인할 수 있어서 유용 (logging을 따로 설정했기에 주석 처리해준다.)
  • format_sql: 로그, 콘솔의 SQL을 좀 더 이쁘게 출력한다 만약 위 설정인 show_sql이 false라면 출력되는 쿼리문이 없으므로, 필요없는 설정이고, 디폴트 값은 false이다

모든 로그 출력은 가급적 로거를 통해 남겨야함

 

Member Entity를 생성한다!

 

MemberRepository도 생성해준다

그리고 ctrl+Shift+T를 눌러서 Test 파일 생성해준다!

@Test는 JUnit4를 사용하면 org.junit.Test를 사용해야함

 

**팁**

tdd를 입력하고 alter+Enter를 누르면 내가 custom한 템플릿을 불러올 수 있다.

설정 > Live templates 에서 custom에 tdd를 추가하면 Template text를 자유롭게 설정할 수 있음!!

 

Ctrl + Alt + V => Extract로 변수 뽑아올 수 있음

 

Test 파일도 설정해주고, application을 실행해주면

 

에러가 난다.

에러 내용을 보면 Transaction에 관한 내용인데,

Entity와 repository에 관한 데이터 전달은 Transaction을 통해 진행되어야 한다.

 

@Transactional annotation 추가해준다!

 

application 실행해주고, 전에 접속했던 h2에 들어가준다 

Member table 생성 확인!

 

Test 파일에 @Transactional 이 들어가있으면 data를 rollback해버린다

@Rollback(false)를 추가해주고 다시 확인해보면

 

table에 data가 추가된 걸 확인할 수 있음! (rollback 안하고 commit)

 

Assertions.assertThat(findMember).isEqualTo(member);

를 test파일에 추가하면, 조회한 멤버와 저장한 멤버가 같을까? => Yes!

 

김영한 실전 스프링부트와 JPA 활용1 수업 듣고 직접 프로젝트 생성하며 작성

개발이나 테스트 용도로 가볍고 편리한 DB이다.

웹 콘솔 화면도 제공해준다.

 

버전 1.4.200을 다운받아준다 !

윈도우 설치 버전: https://h2database.com/h2-setup-2019-10-14.exe

 

설치 후 설치된 경로 폴더 > bin 폴더에 h2.bat을 실행해준다 (맥은 h2.sh)

 

그러면 이렇게 내 ip 주소로 H2 콘솔이 뜬다

JDBC URL에는 연결할 내 프로젝트 파일명로 바꾼다 (test -> jpashop)

 

그러면 jpashop이라는 DB 폴더 생성된 것을 확인할 수 있다!

 

왼쪽 맨 위 빨간색 버튼을 눌러서 연결을 끊고,

그 이후 접속부터는 jdbc:h2:tcp://localhost/~/jpashop 이런식으로 접속해준다!

요즘은 Thymeleaf을 많이 사용하는 추세 

(선택 가능)

Spring에서 Thymeleaf를 미는 중이다

장점으로는 natural templates로 html 내에 마크업을 깨지 않고 그대로 사용할 수 있다.

단점으로는 태그를 완전히 달아줘야함 (ex. <br> </br> 이렇게 마무리 태그 안달아주면 에러난다)

버전 3.0에서는 극복해서 그냥 하나만 달아도 가능

 

이번에는 Thymeleaf로 html 뷰 테스트를 해볼 것이다!

 

우선 기본 Controller 파일을 생성해주고, 코드를 작성한다.

hello라는 uri로 get mapping을 해준다.

 

그리고 templates 하위에 hello.html 파일을 생성한다.

그런 다음 application 실행을 해주고, localhost:8080/hello를 입력하면!

 

Controller에서 받은 data가 hello.html data로 넘겨받고 렌더링된 화면이 보인다!

스프링 부트의 Thymeleaf가 알아서 매핑을 해준다, good... (thymeleaf viewName 매핑)

 

렌더링과 관계없이 정적 페이지에서는 어떻게 설정하고 확인할까?

static > index.html 파일을 추가해준다.

그리고 다시 application 실행을 해주면..!

 

여기서 hello를 클릭해주면 

 

/hello로 바로 이동한다!!

 

**팁**

spring-boot-starterdevtools를 추가하면 매번 코드 수정하고 빌드해야할 필요없이

수정한 파일에 Build > Recompile file 눌러주면 그 부분만 적용돼서 바로 확인 가능!!

 

김영한 실전 스프링부트와 JPA 활용 1 강의 듣고 작성한 글

web 의존성 추가하면 tomcat, mvc도 자동으로 추가된다. => localhost:8080 사용할 때 웹페이지 띄울 수 있도록 해준다

 

스프링 부트 라이브러리

1. spring-boot-starter-web

spring-boot-starter-tomcat: 톰캣 (웹서버)

spring-webmvc: 스프링 웹 MVC

spring-boot-starter-thymeleaf: 타임리프 템플릿 엔진(View)

2. spring-boot-starter-data-jpa

spring-boot-starter-aop

spring-boot-starter-jdbc HikariCP 커넥션 풀 (부트 2.0 기본)

hibernate + JPA: 하이버네이트 + JPA

spring-data-jpa: 스프링 데이터 JPA

3. spring-boot-starter(공통): 스프링 부트 + 스프링 코어 + 로깅

spring-boot spring-core

spring-boot-starter-logging : logback, slf4j

 

테스트 라이브러리

1.spring-boot-starter-test

junit: 테스트 프레임워크

mockito: 목 라이브러리

assertj: 테스트 코드를 좀 더 편하게 작성하게 도와주는 라이브러리

spring-test: 스프링 통합 테스트 지원

 

핵심 라이브러리

스프링 MVC

스프링 ORM

JPA, 하이버네이트

스프링 데이터 JPA

 

기타 라이브러리

H2 데이터베이스 클라이언트 => 다운 받는 H2 데이터베이스 버전이랑 접근하는 클라이언트 버전이랑 안맞으면 충돌 일어날 수 있으니 버전 맞춰줘야함

커넥션 풀: 부트 기본은 HikariCP

WEB(thymeleaf)

로깅 SLF4J & LogBack

테스트

+ Recent posts