지식 줍줍 🐿️

로깅 (logging)

시스템이 작동할 때 당시의 상태와 작동 정보를 기록 

로깅단계

JPA 및 로깅 관련 properties 설정 

-- 프로젝트 내 resources > application.properties (or yaml)

server.servlet.encoding.force = true
spring.h2.console.enable=true
spring.jpa.defer-datasource-initialization=true

# JPA 로깅 설정
logging.level.hibernate.SQL=DEBUG

# 쿼리 줄바꿈
spring.jpa.properties.hibernate.format_sql=true

# 매개변수 값 보여주기
logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE

# 유니크 URL 생성하지 않기
spring.datasource.generate-unique-name=false

# 고정 URL 설정
spring.datasource.url=jdbc:h2:mem:testdb

✎ Vault 

API 을 사용하여 민감정보를 관리하는 시스템.

✱ 민감정보
비밀번호, 토큰, 인증서 등의 암호화 해야하는 어떠한 것들

https://www.vaultproject.io/ 에서 개발함.

✎ Vault 사용 이유

프로젝트 내에 보안적인 요소를 고려해야 하는 값(계정 및 패스워드 = 민감정보 등)들을 HTTP API 통신을 이용하여 외부(=git 저장소 등)에 노출시키지 않은 상태로 사용할 수 있기 때문에 보안에 효율적임.

✎ 간단하게 스프링부트 프로젝트 에서 사용해본 Vault

1. Vault 설치 및 실행 확인

$ brew install vault # vault 설치
$ vault server --dev --dev-root-token-id="00000000-0000-0000-0000-000000000000" # vault 서버 실행

☞ https://www.vaultproject.io/docs/commands/server 에 자세한 설명이 있다.

⁉️ 만약 Get "https://127.0.0.1:8200/v1/sys/internal/ui/mounts/secret/application/db": http: server gave HTTP response to HTTPS client 이러한 에러가 발생하였을 경우
↓↓ 아래내용 실행 (터미널)

$ export VAULT_ADDR='http://localhost:8200'

2. key/vaule 생성 및 확인

$ vault kv put secret/application username=mungmang password=12345 # key, vaule 생성

Key                Value
---                -----
created_time       2022-01-08T15:46:25.89734Z
custom_metadata    <nil>
deletion_time      n/a
destroyed          false
version            1

$ vault kv get secret/application # path 으로 key, vaule 조회 

======= Metadata =======
Key                Value
---                -----
created_time       2022-01-08T15:46:25.89734Z
custom_metadata    <nil>
deletion_time      n/a
destroyed          false
version            1

====== Data ======
Key         Value
---         -----
password    12345
username    mungmang

☞ https://learn.hashicorp.com/collections/vault/getting-started 에 vault 사용 방법에 대해 자세히 설명해준다.

3. SpringBoot project 에 vault 연동여부 적용

// build.gradle 파일에 아래의 정보 추가

ext {
    ...
    set('springCloudVersion', "2021.0.1-SNAPSHOT")
}

dependencies {
	...
	implementation 'org.springframework.cloud:spring-cloud-starter-vault-config'
}
    

dependencyManagement {
    imports {
        mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
    }
}

// application.yml에 아래의 내용 추가
spring:
  config:
    import: vault:// 
  cloud:
    vault:
      uri: http://localhost:8200
      token: 00000000-0000-0000-0000-000000000000
      kv:
        backend: secret
        default-context: application #secret 이후의 경로

✱ 참고로 Spring Cloude Vault 3.0 및 Spring Boot 2.4 이상에선 bootstrap.yml, bootstrap.properties 가 더이상 사용되지 않는다고함. 그리고  Spring Boot Config Data 접근방식을 사용하려면 spring: config: import에 Vault 시스템을 바인딩 하기 위한 속성 설정이 필요함. (Spring Boot 의 Config Data API) 
아님, application.yml에 spring:cloud:bootstrap:enabled: true or pom.xml or build.gradle 파일에 spring-cloud-starter-bootstrap import을 하여 bootstrap.yml 을 활성화를 할 수 있음.

☞ https://docs.spring.io/spring-cloud-vault/docs/current/reference/html/#client-side-usage 에 자세한 설명이 있다.

// config 패키지 생성후 아래의 클래스 생성 

@Getter
@Configuration
public class VaultData {

    @Value("${username}")
    private String username;

    @Value("${password}")
    private String password;
}

// 확인

@Slf4j
@SpringBootApplication
public class HelloApplication {

    public static void main(String[] args) {

        ConfigurableApplicationContext context = SpringApplication.run(HelloApplication.class, args);

        // vault 테스트 --
        VaultData vaultData = context.getBean(VaultData.class);
        log.info("username:{}", vaultData.getUsername());
        log.info("password:{}", vaultData.getPassword());
    }
}

end ~

스프링 클라우드

설명

클라우드 어플리케이션을 구축하기 위한 프레임워크
아래와 같은 내용들을 제공해준다.

    ▶︎ 분산 / 버전 컨피규레이션
        • 분산 컨피규레이션은 클라우드 네이티브 환경에서 인기있는 표준이다. 
        • 스프링 컨피그는 분산시스템에서 외부 컨피규레이션을 위해 서버 측과 클라이언트 측을 지원한다.
            → 중앙 단일 저장소 생성됨. ... vault..
        • 주키퍼(Zookeeper) 등이있다..

    ▶︎ 서비스 등록 & 디스커버리
        • 디스커버리는 컴퓨터 네트워크상의 디바이스가 제공하는 디바이스&서비스를 자동으로 감지하는 서비스이다.
            → 각 서비스들 실행시 중앙 서버에 자신(서비스)을 등록하는것. (IP, Port 등)
            → 클라우드 환경에서 각 서버인스턴스들이 오토스케일링 되거나, 생성 확장등이 될때 IP or Port 등이 변경될 가능성이 높아지기 때문에 이러한 정보들을 캐치하기 위하여 사용함.
        • 넷플릭스 OSS(Open Source Software) 의 디스커버리 패키지 유레카(Eureka)가 있다.
        • 유레카는 클라이언트 & 서버로 구성이 되며, 클라이언트는 원격 디스커러비서버에 연결하는 일을 담당하고
서버는 독립적인 스프링부트 어플리케이션을 담당한다.


    ▶︎ 라우팅
        • 넷플릭스 OSS(Open Source Software) 의 줄(Zuul)이 있다.
        • 줄은 부하분산 및 필터링을 수행하고, 게이트웨이로써의 중요한 역할을 한다.

    ▶︎ 서비스간 호출

        • API 게이트웨이에서 각 서비스를 호출할 때, 도메인으로 호출하지 않고 IP등으로 호출하게 되면 변경된 IP에 대해서는 관련 내용을 업데이트 해줘야 함
        • 디스커버리 서비스는 인스턴스의 ID나 이름으로 호출하기에, 변경된 정보를 불러오는데 문제가 없음. 
        • API 통신할때 사용하는 RestClient 종류로 넷플릭스 OSS(Open Source Software) 의페인(Feign) 이 있다.

    ▶︎ 부하분산
        • 라운드 로빈 규칙을 가지고 디스커버리에 등록된 인스턴스 목록을 가져오는 역할을 한다. (부하분산기)
        • 넷플릭스 OSS(Open Source Software) 의 리본(Ribbon) 이 있다.

    ▶︎ 서킷브레이커
        • 네트워크 타임아웃 문제 해결 
        • 서킷 브레이커: 성공 & 실패 확률을 저장
        • 임계치가 넘으면 차단! 
        • 폴백(fallback) 로직 수행!


    ▶︎ 분산 메세징 
        • AMQP, Apache kafka 등이 있다.

클라우드 네이티브 어플리케이션

설명

클라우드 환경을 위해 잘 설계된 프로그램
https://docs.spring.io/spring-cloud-commons/docs/3.1.1/reference/html/

참고

책: http://www.yes24.com/Product/Goods/66581779
링크: https://mangchhe.github.io/springcloud/2021/04/07/ServiceDiscoveryConcept/

링크: https://www.baeldung.com/spring-cloud-bootstrapping

json web token

설명

JSON 객체를 사용하여 토큰 자체에 정보들을 저장하고 있는 웹토큰.
claims을 안전하게 전달하는 표준.
HMAC 알고리즘 사용 하거나, RSA or ECDSA를 사용하는 공개 / 개인키 쌍을 사용하여 서명이 가능함.
권한 부여 및 정보교환시점에서 사용.

✳︎ claims ?
JWT 의 PAYLOAD 부분을 구성하고 교환되는 정보 집합.

토큰생김새

위와 같은 형태로 생겼으며, https://jwt.io/ 사이트에서 토큰 정보를 확인할 수 있다.

구성방식

HEADER, PAYLOAD, SIGNITURE 으로 구성된다. 
이 세부분은 Base64url 인코딩을 사용하여 별도로 인코딩되며 JWT 생성을 위하 점(.)을 사용하여 연결된다. 

각 구성 설명은 아래와 같다.

동작방식

jwt 토큰 인증 방식 기준으로 그려본것이다. (oauth2의 허가는 생략)

장점과 단점

• 장점
  중앙의 인증서버, 데이터 스토어에 대한 의존성이 없고, 시스템 수평확장에 유리하다.
  
  
• 단점
  PAYLOAD 정보가 많아지면 네트워크 사용량이 증가함.
  토큰이 클라이언트에 저장되기에 서버에서 클라이언트의 토큰을 조작할 수 있다.

참조

https://jwt.io/introduction

https://ko.wikipedia.org/wiki/JSON_%EC%9B%B9_%ED%86%A0%ED%81%B0

https://velog.io/@kshired/Express%EC%97%90%EC%84%9C-JWT%EB%A1%9C-%EC%9D%B8%EC%A6%9D%EC%8B%9C%EC%8A%A4%ED%85%9C-%EA%B5%AC%ED%98%84%ED%95%98%EA%B8%B0-Access-Token%EA%B3%BC-Refresh-Token

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81%EB%B6%80%ED%8A%B8-jwt/dashboard

https://techdocs.akamai.com/api-gateway/docs/json-web-token-jwt-val#jwt-claims

filter

설명

dispatcherServlet 호출 전, 요청에 대해서 전처리 작업(원하는 형태로 변형)이 필요한 경우 사용하는것. (웹 어플리케이션에서 등록)
filter chain 을 통해 연쇄적으로 동작할 수 있게 가능.
인증, 권한, CORS, 인코딩, XSS 작업시 이용

dispatcherServlet

설명

프런트 컨트롤러와 연동되는 진입점 역할을 하며, 기본적인 처리 흐름을 제어하는 사령탑 역할을 한다. 

✿ 프론트 컨트롤러?
클라이언트 요청을 프런트 컨트롤러라는 컴포넌트가 받아 요청 내용에 따라 수행하는 핸들러(Handler)를 선택하는 아키텍처

dispatcherServlet과 연동되는 인터페이스

Handler

설명

프레임워크 관점에서 불리는 Handler는 개발자가 작성하는 클래스의 관점에서 Controller 이다.

HandlerMapping

설명

요청에 대응할 핸들러를 선택하는 역할을 수행한다. (컨트롤러내의 메소드가 핸들러로 인식!)
클라이언트(브라우저)에서 요청이 올 경우 RequestMappingHandlerMapping 클래스는
요청 내용(요청 경로 혹은 HTTP 메서드)과 요청 매핑 정보를 매칭해서 실행할 핸들러르 선택한다!

@Controller
class TestController {
    @RequestMapping("/hello")
    public String hello() {
        return "/hi";
    }
    // hello 메소드가 핸들러!
}

HandlerAdapter

설명

핸들러 메서드를 호출하는 역할을 한다. (RequestMappingHandlerAdapter)
RequestMappingHandlerAdapter 클래스 에서는 핸들러 메서드에 매개변수를 전달하고 메서드의 처리 결과를 반환값으로 되돌려 보냄
빈 객체 검사 등등을 함.

ViewResolver

설명

핸들러에서 반환한 뷰 이름을 보고, 이후에 사용할 View 인터페이스의 구현 클래스를 선택하는 역할을 한다.

참고

(책) 스프링 철저 입문
(책) 스프링 부트로 배우는 자바 웹 개발
https://exhibitlove.tistory.com/7

https://stargatex.wordpress.com/2015/12/08/spring-mvc-request-lifecycle/

상황

H2 db 사용, entity class 에 테이블명을 명시해주지 않음. 
데이터 등록 처리 중 해당 에러 발생 (테이블 시퀀스 값이 없다는 상황)

해결

entity class (@Entity 설정 클래스) 내 id 필드(@Id 설정된 값)의
@GeneratedValue(strategy = GenerationType.AUTO) 설정 부분을
@GeneratedValue(strategy = GenerationType.IDENTITY) 으로 변경
    --> 기본키 생성을 데이터베이스에 위임해주고 id가 null 이면 알아서 auto_increment 해줌

참고

https://stackoverflow.com/questions/39807483/sequence-hibernate-sequence-not-found-sql-statement

https://gmlwjd9405.github.io/2019/08/12/primary-key-mapping.html