0808 ~ 0814

0808 - Procedure와 Function 차이

[ Procedure 프로시저란? ]

데이터베이스에 대한 일련의 작업을 정리한 절차를 관계형 데이터베이스 관리 시스템에 저장한 것으로 영구저장모듈(Persistent Storage Module)이라고 불린다.
일련의 쿼리를 마치 하나의 함수처럼 실행하기 위한 쿼리의 집합이다.
즉, 하나의 작업을 수행하기 위한 쿼리의 모음이다.

CALL 프로시저명(IN파라미터명, @OUT파라미터명)
EXECUTE 프로시저명(IN파라미터명, @OUT파라미터명)

---

CREATE OR REPLACE PROCEDURE 프로시져이름 (파라미터1,파라미터2...);

IS
변수

BEGIN

쿼리문

END 프로시져 이름;

---

CREATE OR REPLACE PROCEDURE GET_TIER(in_name IN VARCHAR2,out_tier OUT VARCHAR2)

IS

BEGIN
	
    SELECT TIER INTO out_tier FROM SUMMONER_TB WHERE NAME = in_name;

EXCEPTION
  --소환사를 찾을 수 없을 때
  WEHN NO_DATA_FOUND THEN
  
    out_tier:='NO_SUMMONER_FOUND';

END GET_TIER;

[ Function 함수란? ]

하나의 특별한 목적의 작업을 수행하기 위해 독립적으로 설계된 코드의 집합.
즉, 함수가 여러 작업을 위한 기능이라면 프로시저는 작업을 정리한 절차이다.
보통 로직을 도와주는 역할이며, 간단한 계산, 수치 등을 나타낼 때 사용한다.

SELECT 함수명(IN 파라미터명) FROM DUAL;

---

CREATE OR REPLACE FUNCTION 함수이름(파라미터1이름 타입, 파라미터2이름 타입...)
RETURN 반환할타입
IS
	변수 선언
BEGIN
	실행문 작성
	RETURN 반환할값
END;

--- 

CREATE OR REPLACE FUNCTION SUM_TWICE(n1 NUMBER, n2 NUMBER)
RETURN NUMBER
IS
	twice_sum  NUMBER := 0;
BEGIN
	twice_sum := (n1 + n2)*2;
	RETURN twice_sum;
END;

[ 함수와 프로시저의 차이 ]

프로시저 또한 매개변수를 받아 여러 작업을 수행하여 값을 반환할 수 있고, 함수 또한 매겨변수를 받아 여러 작업을 수행하여 값을 반환할 수 있다.

매개변수

• 프로시저는 매개변수를 입력, 출력, 입출력 형식으로 받을 수 있다.
• 함수는 매개변수를 입력 형식으로만 받을 수 있다.

반환값

• 프로시저는 반환값을 가질 수 도 있고 가지지 않을 수도 있다.
• 함수는 반환값을 반드시 가져야 한다.

쿼리문 내에서 실행가능

• 프로시저는 SELECT, WHERE 문등에서 사용 불가하다.
• 함수는 SELECT, WHERE 문 등에서 사용이 가능하다.

처리 장소

• 프로시저는 클라이언트(화면)에서 값을 건네받아 서버에서 작업을 한 뒤 클라이언트에게 전달한다. 즉, 서버에서 실행이 되어 속도면에서 빠른 성능을 보여준다.
• 함수는 클라이언트(화면)에서 실행이 되어 프로시저보다 속도가 느리다.

0809 - Feign Client

페인은 넷플릭스에서 개발한 웹 서비스 클라이언트 도구(Http Client 모듈)로 애노테이션을 템플릿화된 요청으로 처리해 동작하는 HTTP 클라이언트 바인더다. 기존 HTTP client 작성을 쉽게 만들어주며 인터페이스를 만들고 애노테이션을 붙이는 방식이기 때문에 간단하게 사용할 수 있는 장점이 있다.

Feign 기본 사용법

[ 의존성주입 ]

• maven

<properties>
    <spring.cloud-version>Hoxton.SR8</spring.cloud-version>
</properties>
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>${spring.cloud-version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

• gradle

buildscript {
  dependencies {
    classpath "io.spring.gradle:dependency-management-plugin:1.0.10.RELEASE"
  }
}

ext {
  set('springCloudVersion', "Hoxton.SR8")
}

apply plugin: "io.spring.dependency-management"

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

[ Application ]

@SpringBootApplication
@EnableFeignClients
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

@EnableFeignClients 어노테이션이 지정된 package들을 돌아다니면서 @FeignClient 어노테이션을 찾아 구현체를 만들어 준다.

[ Interface 작성 ]

@FeignClient(name = "stores", configuration = FooConfiguration.class, url = "${feign.url}")
public interface StoreClient {
    @RequestMapping(method = RequestMethod.GET, value = "/stores")
    List<Store> getStores();

    @RequestMapping(method = RequestMethod.GET, value = "/stores")
    Page<Store> getStores(Pageable pageable);

    @RequestMapping(method = RequestMethod.POST, value = "/stores/{storeId}", consumes = "application/json")
    Store update(@PathVariable("storeId") Long storeId, Store store);
}

• @FeignClent 어노테이션을 통해 feign을 사용하는 인터페이스라고 알린다.
• configuration 옵션을 통해 default 값을 override 할 수 있다.
• url 옵션을 통해 불러올 url을 세팅한다.

[ Service 작성 ]

@Service
public class StoreService {
    
    private final StoreClient storeClient;

	public StoreService(StoreClient storeClient) {
		this.storeClient = storeClient;
	}

    public List<Store> getStores() {
        return storeClient.getStores();
    }
}

• getStores()를 호출하여 FeignClient를 호출한다.

0811 - jenkins pipeline

웹훅없이 기본적이 pipeline으로 클론, 빌드, 배포까지만 진행하는 방법

[ Credentials 세팅 ]

• Jenkins 관리 -> Manage Credentials -> Add Credentials
• Jenkins 관리 -> 시스템 설정 -> GitHub -> 서버등록

[ Git Parameter ]

• Git Parameter Plug-In 설치
• 파이프라인 -> 매개변수 설정

[ SSH 서버로 파일전송 ]

• publish over ssh 플러그인 설치
• Jenkins 관리 -> 시스템 설정 -> 원격 서버 설정

[ 파이프 라인 생성 ]

• 새로운 item -> 파이프라인 생성
• Pipeline Syntax통해 스니펫 설정

pipeline {
    agent any
    parameters {
        gitParameter branchFilter: 'origin/(.*)', defaultValue: 'develop', name: 'BRANCH', type: 'PT_BRANCH'
    }
    stages {
        stage('github clone') {
            steps {
                git branch: "${params.BRANCH}", credentialsId: 'jaesungahn91', url: 'https://github.com/wiiee-kr/wiiee-server.git'
            }
        }
        
        stage('build'){
            steps{
                sh'''
                    ./gradlew api:clean api:bootJar
                '''
            }
        }   
        
        stage('publish on ssh'){
            steps{
                sshPublisher(
                  publishers: 
                    [
                      sshPublisherDesc(
                        configName: 'wiiee-api-test', 
                        transfers: 
                          [
                            sshTransfer(
                              cleanRemote: false, 
                              excludes: '',
                              execCommand: 'sh /home/ec2-user/deploy.sh', 
                              execTimeout: 120000, 
                              flatten: false, 
                              makeEmptyDirs: false, 
                              noDefaultExcludes: false, 
                              patternSeparator: '[, ]+', 
                              remoteDirectory: './', 
                              remoteDirectorySDF: false, 
                              removePrefix: 'api/build/libs/', 
                              sourceFiles: 'api/build/libs/*.jar')
                          ], 
                        usePromotionTimestamp: false, 
                        useWorkspaceInPromotion: false, 
                        verbose: true)
                    ]
                )
            }
        }
    }
}

0813 - Git Submodule

credential 파일 관리를 위한 방법중 하나로 사용하고 있는 Git Submodule에 대해 학습하자.

• git submodule
• 설정파일 암호화
  • Jasypt 라이브러리
• Spring Cloud Config를 통한 설정파일 분리

[ Git Submodule이란 ]

메인 레포지토리에 하위 레포지토리를 두고 관리하기 위한 도구이다. 하나의 프로젝트에서 다른 프로젝트를 함께 사용해야 하는 경우 주로 사용한다. 즉, Git 저장소 안에 다른 Git 저장소를 디렉토리로 분리해 넣는 것이 서브모듈이다. 다른 독립된 Git 저장소를 Clone 해서 내 Git 저장소 안에 포함할 수 있으며 각 저장소의 커밋은 독립적으로 관리한다.

[ Git Submodule 사용방법 ]

서브 모듈추가

• git submodule add {URL}

$ git submodule add https://github.com/chaconinc/DbConnector
Cloning into 'DbConnector'...
remote: Counting objects: 11, done.
remote: Compressing objects: 100% (10/10), done.
remote: Total 11 (delta 0), reused 11 (delta 0)
Unpacking objects: 100% (11/11), done.
Checking connectivity... done.

• 기본적으로 서브모듈은 프로젝트 저장소의 이름으로 디렉토리를 만든다. 디렉토리 이름으로 서브모듈을 추가할 수도 있다.

서브모듈 확인

• git status

$ git status
On branch master
Your branch is up-to-date with 'origin/master'.

Changes to be committed:
  (use "git reset HEAD <file>..." to unstage)

    new file:   .gitmodules
    new file:   DbConnector

• .gitmodules

[submodule "DbConnector"]
    path = DbConnector
    url = https://github.com/chaconinc/DbConnector

• git diff

$ git diff --cached DbConnector
diff --git a/DbConnector b/DbConnector
new file mode 160000
index 0000000..c3f01dc
--- /dev/null
+++ b/DbConnector
@@ -0,0 +1 @@
+Subproject commit c3f01dc8862123d317dd46284b05b6892c7b29bc

• Git은 DbConnector 디렉토리를 서브모듈로 취급하기 때문에 해당 디렉토리 아래의 파일 수정사항을 직접 추적하지 않는다. 대신 서브모듈 디렉토리를 통째로 특별한 커밋으로 취급한다.

$ git diff --cached --submodule
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..71fc376
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "DbConnector"]
+       path = DbConnector
+       url = https://github.com/chaconinc/DbConnector
Submodule DbConnector 0000000...c3f01dc (new submodule)

• git commit & git push

$ git commit -am 'added DbConnector module'
[master fb9093c] added DbConnector module
 2 files changed, 4 insertions(+)
 create mode 100644 .gitmodules
 create mode 160000 DbConnector

DbConnector 디렉토리 모드는 160000이다. git에게 있어 160000모드는 일반적인 파일이나 디렉토리가 아니라 특별하다는 의미이다.

$ git push origin master

서브모듈 포함한 프로젝트 Clone

$ git clone https://github.com/chaconinc/MainProject
Cloning into 'MainProject'...
remote: Counting objects: 14, done.
remote: Compressing objects: 100% (13/13), done.
remote: Total 14 (delta 1), reused 13 (delta 0)
Unpacking objects: 100% (14/14), done.
Checking connectivity... done.
$ cd MainProject
$ ls -la
total 16
drwxr-xr-x   9 schacon  staff  306 Sep 17 15:21 .
drwxr-xr-x   7 schacon  staff  238 Sep 17 15:21 ..
drwxr-xr-x  13 schacon  staff  442 Sep 17 15:21 .git
-rw-r--r--   1 schacon  staff   92 Sep 17 15:21 .gitmodules
drwxr-xr-x   2 schacon  staff   68 Sep 17 15:21 DbConnector
-rw-r--r--   1 schacon  staff  756 Sep 17 15:21 Makefile
drwxr-xr-x   3 schacon  staff  102 Sep 17 15:21 includes
drwxr-xr-x   4 schacon  staff  136 Sep 17 15:21 scripts
drwxr-xr-x   4 schacon  staff  136 Sep 17 15:21 src
$ cd DbConnector/
$ ls
$

• 프로젝트를 Clone하면 기본적으로 서브모듈 디렉토리는 빈 디렉토리이다.
• 이후에 git submodule init 명령을 실행하면 서브모듈 정보를 기반으로 로컬 환경설정 파일이 준비된다. 이후 git submodule update 명령으로 서브모듈의 리모트 저장소에서 데이터를 가져오고 서브모듈을 포함한 프로젝트의 현재 스냅샷에서 Checkout 해야 할 커밋 정보를 가져와서 서브모듈 프로젝트에 대 한 Checkout을 한다.

$ git submodule init
Submodule 'DbConnector' (https://github.com/chaconinc/DbConnector) registered for path 'DbConnector'
$ git submodule update
Cloning into 'DbConnector'...
remote: Counting objects: 11, done.
remote: Compressing objects: 100% (10/10), done.
remote: Total 11 (delta 0), reused 11 (delta 0)
Unpacking objects: 100% (11/11), done.
Checking connectivity... done.
Submodule path 'DbConnector': checked out 'c3f01dc8862123d317dd46284b05b6892c7b29bc'

• DbConnector 디렉토리는 마지막으로 커밋을 했던 상태로 복원된다.
• 방금 과정을 메인 프로젝트를 Clone 할 때 git clone 명령 뒤에 --recurse-submodules 옵션을 붙이면 서브모듈을 자동으로 초기화하고 업데이트한다.

$ git clone --recurse-submodules https://github.com/chaconinc/MainProject
Cloning into 'MainProject'...
remote: Counting objects: 14, done.
remote: Compressing objects: 100% (13/13), done.
remote: Total 14 (delta 1), reused 13 (delta 0)
Unpacking objects: 100% (14/14), done.
Checking connectivity... done.
Submodule 'DbConnector' (https://github.com/chaconinc/DbConnector) registered for path 'DbConnector'
Cloning into 'DbConnector'...
remote: Counting objects: 11, done.
remote: Compressing objects: 100% (10/10), done.
remote: Total 11 (delta 0), reused 11 (delta 0)
Unpacking objects: 100% (11/11), done.
Checking connectivity... done.
Submodule path 'DbConnector': checked out 'c3f01dc8862123d317dd46284b05b6892c7b29bc'

메인 프로젝트에 submodule이 이미 있고, 하위 프로젝트의 새로운 커밋을 가져와야 하는 상황에선 update 명령어를 활용한다. 이 명령어로 메인 프로젝트에서 submodule의 커밋을 가져오면, 이전에 봤던 것처럼 새로 커밋해야 하는 파일이 생긴다. 앞서 한것과 동일하게 해당 파일을 add, commit, push해서 로컬과 원격프로젝트에 반영한다.

$ git submodule update --remote --merge

// .gitmodules 파일에 정의되어 있는 브랜치(default는 main 또는 master)의 최신 버전으로 업데이트
// $ git submodule update --remote

// 로컬에서 작업 중인 부분과 원격에 작업된 부분이 다른 경우 머지까지 진행
// $ git submodule update --remote --merge

0814 - 애노테이션 프로세서(Annotation Processor)

Annotation Processor란?

“Annotation Processing” is a hook into the compile process of the java compiler, to analyse the source code for user defined annotations and handle then (by producing compiler errors, compiler warning, emitting source code, byte code …).

Annotation Processor는 컴파일 단계에서 Annotation에 정의된 일렬의 프로세스를 동작하게 하는 것을 의미한다. 컴파일 단계에서 실행되기 때문에, 빌드 단계에서 에러를 출력하게 할 수 있고 소스코드 및 바이트 코드를 생성할 수도 있다.
사용하는 예로 자바의 @Override가 있으며, Lombok(롬북) 라이브러리도 있다.
기본적으로 포함되어 있는 어노테이션이 아니면 annotationProcessor를 통해 추가해줘야 한다.

Lombok과 Annotation Processor

Lombok이란 @Getter, @Setter, @Builder 등의 Annotation과 Annotation Processor를 제공하여 표준적으로 작성해야 할 코드를 개발자 대신 생성해주는 라이브러리다.
컴파일 시점에 Annotation Processor를 사용하여 abstract syntaxtree를 조작한다.

작동원리

Moja Interface

@Magic
public interface Moja {

    String pullOut();
}

Magic 애노테이션

• Target을 TYPE으로 지정하면, 인터페이스, 클래스, ENUM에 지정이 가능하다.
• Rentention정보를 소스레벨 까지만 유지하고, 컴파일 시점에 애토네이션 프로세서를 사용해 MagicMoja를 생성한다.

@Target(ElementType.TYPE) // TYPE 으로 지정하면, 인터페이스 ,클래스, enum에 지정이 가능함.
@Retention(RetentionPolicy.SOURCE) // 소스레벨에서 만 유지하고, 컴파일시 애노테이션 프로세서로 소스코드를 생성할것임
public @interface Magic {

}

public class App {
    public static void main( String[] args ) {
        // MagicMoja 가 애노테이션 프로세서를 사용해서생성할 클래스이다.
        Moja moja = new MagicMoja();
        System.out.println(moja.pullOut());
    }
}

• 애노테이션 프로세서를 사용하여, @Magic 애노테이션이 적용된 인터페이스가 존재하면, MagicMoja 라는 클래스를 생성한다.

MagicMojaProcessor

/**
 * Process 인터페이스를 구현해도 되지만, 자바에서 제공하는 AbstractProcessor 추상클래스를 구현해도 된다.
 * Process 에서 구현해야하는 여러 메서드들을 구현해주고 있다.
 */
public class MagicMojaProcessor extends AbstractProcessor {

    /**
     * 이 프로세서가 어떤 애노테이션들을 처리할 것인지 설정하는 메서드 오버라이딩.
     *
     * Element란 ?
     * - 패키지
     * - 클래스
     * - 메서드
     * 소스코드의 구성요소를 엘리먼트라고 부른다
     * 각 엘리먼트들이 프로세스를 할때 참조할 수 있다.
     * @return
     */
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        return Set.of(Magic.class.getName());
    }

    /**
     * 몇 버전의 소스코드를 지원하는지 설정.
     * - 최신버전 지원하도록 설정
     * @return
     */
    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }

    /**
     * 애노테이션 프로세서는 라운드 라는 개념으로 처리를 한다.
     * - 여러 라운드에 거쳐 처리를 한다.
     * - 각 라운드마다 프로세서에게 특정 애노테이션을 가지고 있는 엘리먼트를 찾으면 처리를 요청한다.
     * - 처리된 결과가 다음 라운드에게 전달될 수 있다.
     * - Filter Chaining 과 어찌보면 비슷한 느낌이다.
     *
     * 만약 여기서 true를 리턴하면, 애노테이션 프로세서가 처리를 한것이다.
     * true를 리턴하면, 다른 프로세서가 이를 처리하지 않는다.
     * @param annotations
     * @param roundEnv
     * @return
     */
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        /* 적절한 위치에 애노테이션을 사용했는지 체크 */
        /* 애노테이션을 사용한 엘리먼트에 대한 정보를 가져올수 있다.*/
        Set<? extends Element> elementsAnnotatedWith = roundEnv.getElementsAnnotatedWith(Magic.class);
        for (Element element : elementsAnnotatedWith) {
            /* 애노테이션이 인터페이스 아닌곳에 사용했을 경우 */
            if (element.getKind() != ElementKind.INTERFACE) {
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@Magic 애노테이션은 Interface만 지원하는 애노테이션 입니다.");
            } else {
                // 로깅
                processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE, "Processing " + element.getSimpleName());
            }
        }
        return true;
    }
}

• Processor Interface를 사용해도 되지만, 자바에서 기본으로 제공하는 AbstractProcessor 추상 클래스를 사용한다.
  • 인터페이스에서 기본으로 구현해야할 것들을 어느정도 구현하고 있다.

주요 메서드

• getSupportedAnnotationTypes : 이 프로세서가 처리할 애노테이션들을 지정한다.
• getSupportedSourceVersion : 소스코드 버전을 몇까지 지원할 것인지 지정한다.
• process : 애노테이션 프로세서가 애노테이션 프로세서가 처리할 애노테이션을 사용하고 있는 엘리먼트 들을 참조할 수 있다.
  • 엘리먼트란? 소스코드의 구성요소들을 엘리먼트라고 한다(패키지 엘리먼트, 클래스 엘리먼트, 메서드 엘리먼트)
  • 각 엘리먼트들을 프로세스할때 참조가 가능하다.