0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

protobuf.devのAPI Best Practicesを読んでいく全部俺Advent Calendar 2024

Day 16

API Best Practices ~サービス名を意識しユニークなものにする

Posted at

サービス名を意識しユニークなものにする

.proto ファイル内の service キーワードの後の部分であるサービス名は、サービスのクラス名を生成するだけでなく、驚くほど多くの場所で使用されます。
そのため、この名前は思っている以上に重要です。

厄介なのは、サービス名がネットワーク全体で一意であるという暗黙の仮定をしていることです。
さらに悪いことに、それらが使用するサービス名は、修飾されていないサービス名(たとえば、MyService)であり、修飾されたサービス名(たとえば、my_package.MyService)ではありません。

このため、特定のパッケージ内に定義されている場合でも、サービス名の命名衝突を防ぐための措置を講じるのが理にかなっています。
たとえば、Watcher という名前のサービスは問題を引き起こす可能性が高いため、MyProjectWatcher のような名前の方が適しています。


メッセージには、パッケージ名が付けられるため、メッセージ名はパッケージ内で一意である必要はありません。
冗長性を避けるために、メッセージ名は短く保つことが一般的です。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?