<div id="readability-page-1" class="page"><div>
                <p><a href="/m/category/JAVA/spring"><span>JAVA/spring</span></a></p><h3>gRPC 붙이기, submodule을 곁들이고 github 멀티 계정의 귀찮음을 같이 처리하기 위한 스크립트</h3>
              </div><p><cite>Berno</cite>
                <span> 2024. 1. 1. 17:31</span>
              </p><div>
                                <h3 data-ke-size="size23"><b>0. 이 글을 작성하는 이유</b></h3>
<p data-ke-size="size16">토이 프로젝트를 진행하면서 gRPC를 사용하려는데 rpc파일들은 submodule로 관리를 하려고 한다. 일단 붙이긴 해서 여기서 더 효율적인 gradle내용과 이쁘게 하기 위해 수정은 해야겠지만 기록 및 공유하기 위함</p>

<h3 data-ke-size="size23"><b>1. 일단 왜 gRPC를 붙이려고 했는가?</b></h3>
<p data-ke-size="size16">토이 프로젝트가 MSA환경으로 구축하고 있는데 각 서비스 간 통신을 하기 위해 gRPC를 택했다.</p>

<h3 data-ke-size="size23"><b>2. 그래서 gradle은 어떻게 했는가?</b></h3>
<p data-ke-size="size16">인터넷 짜집기를 좀 많이 했다. 분명 수정해야 할 것들이 존재할 거다.</p>
<p data-ke-size="size16">내가 작성한 gradle은 아래와 같다.</p>
<pre id="code_1704097158584" data-ke-language="kotlin" data-ke-type="codeblock"><code>import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
import com.google.protobuf.gradle.*

plugins {
    id("org.springframework.boot") version "3.2.0"
    id("io.spring.dependency-management") version "1.1.4"
    id("com.google.protobuf") version "0.9.4"
    kotlin("plugin.noarg") version "1.5.30"
    kotlin("jvm") version "1.9.20"
    kotlin("plugin.spring") version "1.9.20"
}

apply(plugin = "com.google.protobuf")

group = "com.cooffee"
version = "0.0.1-SNAPSHOT"

java {
    sourceCompatibility = JavaVersion.VERSION_17
}

noArg {
    annotation("jakarta.persistence.Entity") // Java EE면 javax.persistence.Entity
}

val grpcVersion = "1.59.1"
val protobufVersion = "3.25.1"
val protocVersion = protobufVersion

repositories {
    mavenCentral()
}
sourceSets {
    main {
        java {
            srcDir("src/main/generatedProto")
        }
    }
}
dependencies {
    implementation("org.springframework.boot:spring-boot-starter-web")
    implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
    implementation("org.jetbrains.kotlin:kotlin-reflect")
    implementation("org.springframework.boot:spring-boot-starter-data-jpa")
    implementation("io.grpc:grpc-protobuf:${grpcVersion}")
    implementation("io.grpc:grpc-stub:${grpcVersion}")
    testImplementation("org.springframework.boot:spring-boot-starter-test")
}

protobuf {
    protoc { artifact = "com.google.protobuf:protoc:${protocVersion}" }
    plugins {
        id("grpc") {
            artifact = "io.grpc:protoc-gen-grpc-java:${grpcVersion}"
        }
    }

    generateProtoTasks {
        ofSourceSet("main").forEach { task -&gt;
            task.builtins {
                all().forEach {
                    it.plugins {
                        id("grpc")
                    }
                }
            }
        }
        setGeneratedFilesBaseDir("$projectDir/src/generatedProto")
    }

    tasks.withType&lt;KotlinCompile&gt; {
        kotlinOptions {
            freeCompilerArgs += "-Xjsr305=strict"
            jvmTarget = "17"
        }
    }

    tasks.withType&lt;Test&gt; {
        useJUnitPlatform()
    }
}</code></pre>
<p data-ke-size="size16">주로 참고한 건 아래 github을 참고했다.</p>
<p data-ke-size="size16"><a href="https://github.com/grpc/grpc-java/blob/master/examples/build.gradle">https://github.com/grpc/grpc-java/blob/master/examples/build.gradle</a></p>

<h3 data-ke-size="size23"><b>3. 일단 gRPC 설정은 되었다면 proto파일은 어떻게 땡겼는가?</b></h3>
<p data-ke-size="size16">git submodule을 이용했다. 각 서비스들에서 공통된 proto를 사용하려면 이렇게 관리하는 게 더 좋을 것으로 판단했다.</p>
<p data-ke-size="size16">명령어는 아래와 같다.</p>
<blockquote data-ke-style="style3"><span>git submodule add [SUBMODULE_REPOSITORY_URL] [LOCATION]</span></blockquote>
<p data-ke-size="size16">LOCATION에는 내가 가져온 submodule이 어디에 위치할지 정하는 부분이다. 나는 src/main/proto로 지정했다. 왜냐하면 gRPC에서 최초로 proto파일을 찾는 지점이 src/main/proto 디렉토리이기 때문이다.</p>

<h3 data-ke-size="size23"><b>4. proto파일 예시는?</b></h3>
<p data-ke-size="size16">일단 테스트를 위해 간단하게 하나만 작성했다.</p>
<pre id="code_1704097521848" data-ke-language="kotlin" data-ke-type="codeblock"><code>syntax = "proto3";

option java_multiple_files = true;
package com.cooffee.orderservice.v1;

service Order {
    rpc GetOrder(OrderRequest) returns (OrderResponse);
}

message OrderRequest {
    string user_id = 1;
}

message OrderResponse {
    string test_response = 1;
}</code></pre>
<p data-ke-size="size16">패키지에 대해 명시해 주고 하나의 파일이 아닌 쪼개진 파일로 생성하기 위해 java_multiple_files 옵션을 true로 주었다.(default : false)</p>

<h3 data-ke-size="size23"><b>5. 그래서 생성은 되었는가?</b></h3>
<figure data-ke-mobilestyle="widthOrigin" data-origin-width="1888" data-origin-height="1206">
    <span data-url="https://blog.kakaocdn.net/dn/1Gu7A/btsCU1tu1qK/B8zeikhAXMEGJ5zIKZFlO1/img.png" data-lightbox="lightbox">
        <img src="https://blog.kakaocdn.net/dn/1Gu7A/btsCU1tu1qK/B8zeikhAXMEGJ5zIKZFlO1/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" width="804" height="514" data-origin-width="1888" data-origin-height="1206">
    </span>
    
</figure>
<p data-ke-size="size16">되었다.</p>

<h3 data-ke-size="size23"><b>6. 생성은 근데 어떻게 했는가?</b></h3>
<p data-ke-size="size16">위 gradle이 정상동작 되었다면 generateProto 기능이 생긴다.</p>
<figure data-ke-mobilestyle="widthOrigin" data-origin-width="1888" data-origin-height="1206">
    <span data-url="https://blog.kakaocdn.net/dn/Pgylj/btsCX7myyiB/g7w7qTh6G5TLHr3986HIz0/img.png" data-lightbox="lightbox">
        <img src="https://blog.kakaocdn.net/dn/Pgylj/btsCX7myyiB/g7w7qTh6G5TLHr3986HIz0/img.png" onerror="this.onerror=null; this.src='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png'; this.srcset='//t1.daumcdn.net/tistory_admin/static/images/no-image-v1.png';" data-origin-width="1888" data-origin-height="1206">
    </span>
    
</figure>

<h3 data-ke-size="size23"><b>7. 그 github 멀티 계정 이야기나 좀 해보자.</b></h3>
<p data-ke-size="size16">하나의 노트북에서 회사 계정과 내 계정이 섞이다 보니 레포를 작업할 때마다 내 원래 계정으로 초기화를 시켜줘야 하는데 이게 귀찮아서 그냥 스크립트를 하나 만들었다. 나는 zsh을 사용하다 보니 이렇게 주었다.</p>
<pre id="code_1704097725224" data-ke-language="bash" data-ke-type="codeblock"><code>#!/bin/zsh

REPOSITORY_NAME=$1

git remote remove origin
git remote add origin git@github.com-[내 github이름]:[조직 이름]/$REPOSITORY_NAME.git
# initialize git
git init
git config user.name [내 github이름]
git config user.email [내 github이메일]
git branch -M master
git add --all
git commit -m "first commit"
git push -u origin master</code></pre>
<p data-ke-size="size16">일단 최초에 돌리면 잘 돌아가게 되어있다.</p>

<h3 data-ke-size="size23"><b>8. 뭘 배웠는가</b></h3>
<p data-ke-size="size16">.gitmodules 파일을 실제로 볼 일이 없었는데 봐봤다.</p>
<p data-ke-size="size16">스크립트도 간만에 짜봤다.</p>
<p data-ke-size="size16">gRPC설정을 처음부터 해보는데 이것저것 좀 볼게 많았다.</p>
            
            
                </div></div>

흔한 컴공출신 개발자

bernoyoun

0. 이 글을 작성하는 이유
토이 프로젝트를 진행하면서 gRPC를 사용하려는데 rpc파일들은 submodule로 관리를 하려고 한다. 일단 붙이긴 해서 여기서 더 효율적인 gradle내용과 이쁘게 하기 위해 수정은 해야겠지만 기록 및 공유하기 위함
 
1. 일단 왜 gRPC를 붙이려고 했는가?
토이 프로젝트가 MSA환경으로 구축하고 있는데 각 서비스 간 통신을 하기 위해 gRPC를 택했다.
 
2. 그래서 gradle은 어떻게 했는가?
인터넷 짜집기를 좀 많이 했다. 분명 수정해야 할 것들이 존재할 거다.
내가 작성한 gradle은 아래와 같다.
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
import com.google.protobuf.gradle.*
plugins {
    id("org.springframework.boot") version "3.2.0"
    id("io.spring.dependency-management") version "1.1.4"
    id("com.google.protobuf") version "0.9.4"
    kotlin("plugin.noarg") version "1.5.30"
    kotlin("jvm") version "1.9.20"
    kotlin("plugin.spring") version "1.9.20"
}
apply(plugin = "com.google.protobuf")
group = "com.cooffee"
version = "0.0.1-SNAPSHOT"
java {
    sourceCompatibility = JavaVersion.VERSION_17
}
noArg {
    annotation("jakarta.persistence.Entity") // Java EE면 javax.persistence.Entity
}
val grpcVersion = "1.59.1"
val protobufVersion = "3.25.1"
val protocVersion = protobufVersion
repositories {
    mavenCentral()
}
sourceSets {
    main {
        java {
            srcDir("src/main/generatedProto")
        }
    }
}
dependencies {
    implementation("org.springframework.boot:spring-boot-starter-web")
    implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
    implementation("org.jetbrains.kotlin:kotlin-reflect")
    implementation("org.springframework.boot:spring-boot-starter-data-jpa")
    implementation("io.grpc:grpc-protobuf:${grpcVersion}")
    implementation("io.grpc:grpc-stub:${grpcVersion}")
    testImplementation("org.springframework.boot:spring-boot-starter-test")
}
protobuf {
    protoc { artifact = "com.google.protobuf:protoc:${protocVersion}" }
    plugins {
        id("grpc") {
            artifact = "io.grpc:protoc-gen-grpc-java:${grpcVersion}"
        }
    }
    generateProtoTasks {
        ofSourceSet("main").forEach { task ->
            task.builtins {
                all().forEach {
                    it.plugins {
                        id("grpc")
                    }
                }
            }
        }
        setGeneratedFilesBaseDir("$projectDir/src/generatedProto")
    }
    tasks.withType<KotlinCompile> {
        kotlinOptions {
            freeCompilerArgs += "-Xjsr305=strict"
            jvmTarget = "17"
        }
    }
    tasks.withType<Test> {
        useJUnitPlatform()
    }
}
주로 참고한 건 아래 github을 참고했다.
https://github.com/grpc/grpc-java/blob/master/examples/build.gradle
 
3. 일단 gRPC 설정은 되었다면 proto파일은 어떻게 땡겼는가?
git submodule을 이용했다. 각 서비스들에서 공통된 proto를 사용하려면 이렇게 관리하는 게 더 좋을 것으로 판단했다.
명령어는 아래와 같다.
git submodule add [SUBMODULE_REPOSITORY_URL] [LOCATION]
LOCATION에는 내가 가져온 submodule이 어디에 위치할지 정하는 부분이다. 나는 src/main/proto로 지정했다. 왜냐하면 gRPC에서 최초로 proto파일을 찾는 지점이 src/main/proto 디렉토리이기 때문이다.
 
4. proto파일 예시는?
일단 테스트를 위해 간단하게 하나만 작성했다.
syntax = "proto3";
option java_multiple_files = true;
package com.cooffee.orderservice.v1;
service Order {
    rpc GetOrder(OrderRequest) returns (OrderResponse);
}
message OrderRequest {
    string user_id = 1;
}
message OrderResponse {
    string test_response = 1;
}
패키지에 대해 명시해 주고 하나의 파일이 아닌 쪼개진 파일로 생성하기 위해 java_multiple_files 옵션을 true로 주었다.(default : false)
 
5. 그래서 생성은 되었는가?
되었다.
 
6. 생성은 근데 어떻게 했는가?
위 gradle이 정상동작 되었다면 generateProto 기능이 생긴다.
 
7. 그 github 멀티 계정 이야기나 좀 해보자.
하나의 노트북에서 회사 계정과 내 계정이 섞이다 보니 레포를 작업할 때마다 내 원래 계정으로 초기화를 시켜줘야 하는데 이게 귀찮아서 그냥 스크립트를 하나 만들었다. 나는 zsh을 사용하다 보니 이렇게 주었다.
#!/bin/zsh
REPOSITORY_NAME=$1
git remote remove origin
git remote add origin git@github.com-[내 github이름]:[조직 이름]/$REPOSITORY_NAME.git
# initialize git
git init
git config user.name [내 github이름]
git config user.email [내 github이메일]
git branch -M master
git add --all
git commit -m "first commit"
git push -u origin master
일단 최초에 돌리면 잘 돌아가게 되어있다.
 
8. 뭘 배웠는가
.gitmodules 파일을 실제로 볼 일이 없었는데 봐봤다.
스크립트도 간만에 짜봤다.
gRPC설정을 처음부터 해보는데 이것저것 좀 볼게 많았다.

gRPC 붙이기, submodule을 곁들이고 github 멀티 계정의 귀찮음을 같이 처리하기 위한 스크립트

댓글