Go の Micro について学習します。

Micro - Golang learning step 10-3

<p><a href="https://roadmap.sh/" rel="noopener noreferrer" target="_blank">roadmap.sh</a> > <a href="https://roadmap.sh/golang" rel="noopener noreferrer" target="_blank">Go</a> > Tool for Microservices > Micro の学習を進めていきます。</p>
<div class="img_wrap"><amp-img layout="responsive" src="/images/posts/314/01.png" width="1576" height="1146" alt="学習箇所"></div>
<p><span class="small">※ 学習メモとしての記録ですが、後にこのセクションを学ぶ道しるべとなるよう、ですます調で記載しています。</span></p>
<h2 id="contents">contents</h2>
<ol>
<li><a href="#%E9%96%8B%E7%99%BA%E7%92%B0%E5%A2%83">開発環境</a></li>
<li><a href="#%E5%8F%82%E8%80%83-url">参考 URL</a></li>
<li><a href="#micro">Micro</a></li>
<li><a href="#micro-%E3%81%AE%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">Micro のインストール</a></li>
<li><a href="#micro-%E3%82%B5%E3%83%BC%E3%83%90%E3%83%BC%E3%81%AE%E8%B5%B7%E5%8B%95%E3%81%A8%E8%AA%8D%E8%A8%BC">micro サーバーの起動と認証</a></li>
<li><a href="#%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%81%AE%E4%BD%9C%E6%88%90">サービスの作成</a></li>
<li><a href="#protocol-buffers-%E3%81%AE%E3%82%B3%E3%83%B3%E3%83%91%E3%82%A4%E3%83%AB">Protocol Buffers のコンパイル</a></li>
<li><a href="#%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%81%AE%E8%B5%B7%E5%8B%95">サービスの起動</a></li>
<li><a href="#%E5%8B%95%E4%BD%9C%E7%A2%BA%E8%AA%8D">動作確認</a></li>
<li><a href="#micro-%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89">micro コマンド</a></li>
</ol>
<h2 id="開発環境">開発環境</h2>
<ul>
<li>チップ: Apple M2 Pro</li>
<li>OS: macOS Sonoma</li>
<li>go version: go1.23.2 darwin/arm64</li>
</ul>
<h2 id="参考-url">参考 URL</h2>
<ul>
<li><a href="https://github.com/micro/micro?tab=readme-ov-file" rel="noopener noreferrer" target="_blank">[OpenSource] Micro</a></li>
</ul>
<h2 id="micro">Micro</h2>
<p>Microは、Go言語でマイクロサービスを開発・管理するためのプラットフォームです。サービスディスカバリや通信プロトコルの管理など、マイクロサービス開発に必要な基本機能を提供し、開発者が複雑な分散システムを簡潔に扱えるよう支援します。</p>
<h2 id="micro-のインストール">Micro のインストール</h2>
<p>Micro は Go のパッケージとして提供されています。以下のコマンドでインストールします。</p>
<pre><code class="hljs language-console">go install github.com/micro/micro/v5/cmd/micro@master
</code></pre>
<p>インストール後、micro コマンドが使用可能になります。バージョンを確認して、正しくインストールされたことを確認してください。</p>
<pre><code class="hljs language-console">micro --version
</code></pre>
<h2 id="micro-サーバーの起動と認証">micro サーバーの起動と認証</h2>
<p>micro サーバーを起動します。</p>
<pre><code class="hljs language-console">micro server
</code></pre>
<p>起動したら、別の画面から以下コマンドを実行し、環境設定を local に切り替えます。</p>
<pre><code class="hljs language-console">micro env set local
</code></pre>
<p>なお、環境設定は以下コマンドで確認可能です。</p>
<pre><code class="hljs language-console">micro env
</code></pre>
<p>また、micro サーバーには auth サービスが稼働しており、サーバーのステータスを確認したり、エンドポイントにリクエストするために予め認証しておく必要があります。</p>
<p><code>micro login</code> で認証を実施します。</p>
<pre><code class="hljs language-console">micro login

Enter username: admin
Enter password: micro
</code></pre>
<p>ここまでで micro サーバーの初期設定は完了です。</p>
<h2 id="サービスの作成">サービスの作成</h2>
<p>Microには、新しいサービスの雛形を作成するためのコマンドが用意されています。以下のコマンドで、helloworldという名前のサービスを作成します。</p>
<pre><code class="hljs language-console">micro new helloworld
</code></pre>
<p>このコマンドにより、以下のようなディレクトリ構成が生成されます。</p>
<pre><code class="hljs language-console">helloworld/
├── main.go
├── handler
│   └── helloworld.go
├── proto
│   └── helloworld.proto
├── dep-install.mk
├── Makefile
├── README.md
├── .gitignore
└── go.mod
</code></pre>
<h2 id="protocol-buffers-のコンパイル">Protocol Buffers のコンパイル</h2>
<p>サービス間通信にはgRPCを使用します。そのため、Protocol Buffers（.protoファイル）から Go のコードを生成する必要があります。以下のコマンドで、必要なツールをインストールします。</p>
<pre><code class="hljs language-console">go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install github.com/micro/micro/v2/cmd/protoc-gen-micro@latest
</code></pre>
<p>次に、Makefile を使用してプロトコルバッファをコンパイルします。</p>
<pre><code class="hljs language-console">cd helloworld
make init
make proto
go mod tidy
go mod vendor
</code></pre>
<h2 id="サービスの起動">サービスの起動</h2>
<p>以下のコマンドでサービスを起動します</p>
<pre><code class="hljs language-console">micro run .
</code></pre>
<p><code>micro status</code> でサービスの状態を確認できます</p>
<pre><code class="hljs language-console">micro status

NAME            VERSION SOURCE                            STATUS  BUILD   UPDATED         METADATA
helloworld      latest  /path/to/projectroot/helloworld   running n/a     36m29s ago      owner=admin, group=micro
</code></pre>
<h2 id="動作確認">動作確認</h2>
<p><code>micro</code> コマンドでサービスにリクエストを送信します。</p>
<p>リクエスト:</p>
<pre><code class="hljs language-console">micro call helloworld Helloworld.Call '{"name": "taro"}'
<span class="hljs-meta prompt_">
# </span><span class="bash">または</span>

micro helloworld call --name=taro
</code></pre>
<p>レスポンス:</p>
<pre><code class="hljs language-console">{
        "msg": "Hello taro"
}
</code></pre>
<p>curl コマンドからでもリクエストを送信できます。</p>
<p>リクエスト:</p>
<pre><code class="hljs language-console">curl "http://localhost:8080/helloworld/Call?name=taro"
</code></pre>
<p>レスポンス:</p>
<pre><code class="hljs language-console">{
        "msg": "Hello taro"
}
</code></pre>
<h2 id="micro-コマンド">micro コマンド</h2>
<pre><code class="hljs language-console">NAME:
micro - API first development platform

USAGE:
micro [global options] command [command options]

VERSION:
latest

COMMANDS:
auth      Manage authentication, accounts and rules
call      Call a service e.g micro call greeter Say.Hello '{"name": "John"}'
config    Manage configuration values
env       Get/set micro cli environment
gen       Generate a micro related dependencies e.g protobuf
get       Get resources from micro
init      Generate a profile for micro plugins
kill      Kill a service: micro kill [source]
login     Interactive login flow.
logout    Logout.
logs      Get logs for a service e.g. micro logs helloworld
new       Create a service template
run       Run a service: micro run [source]
server    Run the micro server
service   
services  List services in the registry
shutdown  Shutdown a micro server
status    Get the status of services
store     Commands for accessing the store
stream    Create a service stream e.g. micro stream foo Bar.Baz '{"key": "value"}'
update    Update a service: micro update [source]
user      Print the current logged in user
web       Run the micro web UI
help, h   Shows a list of commands or help for one command

GLOBAL OPTIONS:
-c value               Set the config file: Defaults to ~/.micro/config.json [$MICRO_CONFIG_FILE]
--env value, -e value  Set the environment to operate in [$MICRO_ENV]
--namespace value      Namespace the service is operating in (default: "micro") [$MICRO_NAMESPACE]
--client_id value      Account ID used for client authentication [$MICRO_CLIENT_ID]
--client_secret value  Account secret used for client authentication [$MICRO_CLIENT_SECRET]
--public_key value     Public key for JWT auth (base64 encoded PEM) [$MICRO_PUBLIC_KEY]
--private_key value    Private key for JWT auth (base64 encoded PEM) [$MICRO_PRIVATE_KEY]
--name value           Set the service name [$MICRO_SERVICE_NAME]
--profile value        Set the micro server profile: e.g. local or kubernetes [$MICRO_SERVICE_PROFILE]
--network value        Service network address [$MICRO_SERVICE_NETWORK]
--help, -h             show help
--version, -v          print the version
</code></pre>
<h2 id="まとめ">まとめ</h2>
<p>公式リファレンスがドメイン切れで参照できないため詳細が追えないためここまでとする。</p>
<hr>
<hr>
<p>[Next] <a href="/posts/315">Step 10-4: go-zero</a></p>
<p>[Prev] <a href="/posts/313">Step 10-2: Rpcx</a></p>

<p><a href="https://roadmap.sh/" rel="noopener noreferrer" target="_blank">roadmap.sh</a> > <a href="https://roadmap.sh/golang" rel="noopener noreferrer" target="_blank">Go</a> > Tool for Microservices > Micro の学習を進めていきます。</p>
<div class="img_wrap"><img src="/images/posts/314/01.png" width="1576" height="1146" alt="学習箇所"></div>
<p><span class="small">※ 学習メモとしての記録ですが、後にこのセクションを学ぶ道しるべとなるよう、ですます調で記載しています。</span></p>
<h2 id="contents">contents</h2>
<ol>
<li><a href="#%E9%96%8B%E7%99%BA%E7%92%B0%E5%A2%83">開発環境</a></li>
<li><a href="#%E5%8F%82%E8%80%83-url">参考 URL</a></li>
<li><a href="#micro">Micro</a></li>
<li><a href="#micro-%E3%81%AE%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">Micro のインストール</a></li>
<li><a href="#micro-%E3%82%B5%E3%83%BC%E3%83%90%E3%83%BC%E3%81%AE%E8%B5%B7%E5%8B%95%E3%81%A8%E8%AA%8D%E8%A8%BC">micro サーバーの起動と認証</a></li>
<li><a href="#%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%81%AE%E4%BD%9C%E6%88%90">サービスの作成</a></li>
<li><a href="#protocol-buffers-%E3%81%AE%E3%82%B3%E3%83%B3%E3%83%91%E3%82%A4%E3%83%AB">Protocol Buffers のコンパイル</a></li>
<li><a href="#%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%81%AE%E8%B5%B7%E5%8B%95">サービスの起動</a></li>
<li><a href="#%E5%8B%95%E4%BD%9C%E7%A2%BA%E8%AA%8D">動作確認</a></li>
<li><a href="#micro-%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89">micro コマンド</a></li>
</ol>
<h2 id="開発環境">開発環境</h2>
<ul>
<li>チップ: Apple M2 Pro</li>
<li>OS: macOS Sonoma</li>
<li>go version: go1.23.2 darwin/arm64</li>
</ul>
<h2 id="参考-url">参考 URL</h2>
<ul>
<li><a href="https://github.com/micro/micro?tab=readme-ov-file" rel="noopener noreferrer" target="_blank">[OpenSource] Micro</a></li>
</ul>
<h2 id="micro">Micro</h2>
<p>Microは、Go言語でマイクロサービスを開発・管理するためのプラットフォームです。サービスディスカバリや通信プロトコルの管理など、マイクロサービス開発に必要な基本機能を提供し、開発者が複雑な分散システムを簡潔に扱えるよう支援します。</p>
<h2 id="micro-のインストール">Micro のインストール</h2>
<p>Micro は Go のパッケージとして提供されています。以下のコマンドでインストールします。</p>
<pre><code class="hljs language-console">go install github.com/micro/micro/v5/cmd/micro@master
</code></pre>
<p>インストール後、micro コマンドが使用可能になります。バージョンを確認して、正しくインストールされたことを確認してください。</p>
<pre><code class="hljs language-console">micro --version
</code></pre>
<h2 id="micro-サーバーの起動と認証">micro サーバーの起動と認証</h2>
<p>micro サーバーを起動します。</p>
<pre><code class="hljs language-console">micro server
</code></pre>
<p>起動したら、別の画面から以下コマンドを実行し、環境設定を local に切り替えます。</p>
<pre><code class="hljs language-console">micro env set local
</code></pre>
<p>なお、環境設定は以下コマンドで確認可能です。</p>
<pre><code class="hljs language-console">micro env
</code></pre>
<p>また、micro サーバーには auth サービスが稼働しており、サーバーのステータスを確認したり、エンドポイントにリクエストするために予め認証しておく必要があります。</p>
<p><code>micro login</code> で認証を実施します。</p>
<pre><code class="hljs language-console">micro login

Enter username: admin
Enter password: micro
</code></pre>
<p>ここまでで micro サーバーの初期設定は完了です。</p>
<h2 id="サービスの作成">サービスの作成</h2>
<p>Microには、新しいサービスの雛形を作成するためのコマンドが用意されています。以下のコマンドで、helloworldという名前のサービスを作成します。</p>
<pre><code class="hljs language-console">micro new helloworld
</code></pre>
<p>このコマンドにより、以下のようなディレクトリ構成が生成されます。</p>
<pre><code class="hljs language-console">helloworld/
├── main.go
├── handler
│   └── helloworld.go
├── proto
│   └── helloworld.proto
├── dep-install.mk
├── Makefile
├── README.md
├── .gitignore
└── go.mod
</code></pre>
<h2 id="protocol-buffers-のコンパイル">Protocol Buffers のコンパイル</h2>
<p>サービス間通信にはgRPCを使用します。そのため、Protocol Buffers（.protoファイル）から Go のコードを生成する必要があります。以下のコマンドで、必要なツールをインストールします。</p>
<pre><code class="hljs language-console">go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install github.com/micro/micro/v2/cmd/protoc-gen-micro@latest
</code></pre>
<p>次に、Makefile を使用してプロトコルバッファをコンパイルします。</p>
<pre><code class="hljs language-console">cd helloworld
make init
make proto
go mod tidy
go mod vendor
</code></pre>
<h2 id="サービスの起動">サービスの起動</h2>
<p>以下のコマンドでサービスを起動します</p>
<pre><code class="hljs language-console">micro run .
</code></pre>
<p><code>micro status</code> でサービスの状態を確認できます</p>
<pre><code class="hljs language-console">micro status

NAME            VERSION SOURCE                            STATUS  BUILD   UPDATED         METADATA
helloworld      latest  /path/to/projectroot/helloworld   running n/a     36m29s ago      owner=admin, group=micro
</code></pre>
<h2 id="動作確認">動作確認</h2>
<p><code>micro</code> コマンドでサービスにリクエストを送信します。</p>
<p>リクエスト:</p>
<pre><code class="hljs language-console">micro call helloworld Helloworld.Call '{"name": "taro"}'
<span class="hljs-meta prompt_">
# </span><span class="bash">または</span>

micro helloworld call --name=taro
</code></pre>
<p>レスポンス:</p>
<pre><code class="hljs language-console">{
        "msg": "Hello taro"
}
</code></pre>
<p>curl コマンドからでもリクエストを送信できます。</p>
<p>リクエスト:</p>
<pre><code class="hljs language-console">curl "http://localhost:8080/helloworld/Call?name=taro"
</code></pre>
<p>レスポンス:</p>
<pre><code class="hljs language-console">{
        "msg": "Hello taro"
}
</code></pre>
<h2 id="micro-コマンド">micro コマンド</h2>
<pre><code class="hljs language-console">NAME:
micro - API first development platform

USAGE:
micro [global options] command [command options]

VERSION:
latest

COMMANDS:
auth      Manage authentication, accounts and rules
call      Call a service e.g micro call greeter Say.Hello '{"name": "John"}'
config    Manage configuration values
env       Get/set micro cli environment
gen       Generate a micro related dependencies e.g protobuf
get       Get resources from micro
init      Generate a profile for micro plugins
kill      Kill a service: micro kill [source]
login     Interactive login flow.
logout    Logout.
logs      Get logs for a service e.g. micro logs helloworld
new       Create a service template
run       Run a service: micro run [source]
server    Run the micro server
service   
services  List services in the registry
shutdown  Shutdown a micro server
status    Get the status of services
store     Commands for accessing the store
stream    Create a service stream e.g. micro stream foo Bar.Baz '{"key": "value"}'
update    Update a service: micro update [source]
user      Print the current logged in user
web       Run the micro web UI
help, h   Shows a list of commands or help for one command

GLOBAL OPTIONS:
-c value               Set the config file: Defaults to ~/.micro/config.json [$MICRO_CONFIG_FILE]
--env value, -e value  Set the environment to operate in [$MICRO_ENV]
--namespace value      Namespace the service is operating in (default: "micro") [$MICRO_NAMESPACE]
--client_id value      Account ID used for client authentication [$MICRO_CLIENT_ID]
--client_secret value  Account secret used for client authentication [$MICRO_CLIENT_SECRET]
--public_key value     Public key for JWT auth (base64 encoded PEM) [$MICRO_PUBLIC_KEY]
--private_key value    Private key for JWT auth (base64 encoded PEM) [$MICRO_PRIVATE_KEY]
--name value           Set the service name [$MICRO_SERVICE_NAME]
--profile value        Set the micro server profile: e.g. local or kubernetes [$MICRO_SERVICE_PROFILE]
--network value        Service network address [$MICRO_SERVICE_NETWORK]
--help, -h             show help
--version, -v          print the version
</code></pre>
<h2 id="まとめ">まとめ</h2>
<p>公式リファレンスがドメイン切れで参照できないため詳細が追えないためここまでとする。</p>
<hr>
<hr>
<p>[Next] <a href="/posts/315">Step 10-4: go-zero</a></p>
<p>[Prev] <a href="/posts/313">Step 10-2: Rpcx</a></p>

Author