{"componentChunkName":"component---src-modules-datocms-post-page-page-tsx","path":"/posts/44","result":{"data":{"post":{"title":"英語？日本語？マイクロサービスのエラーメッセージは何語が良い？","author":{"name":"suin","images":{"r32":{"src":"https://www.datocms-assets.com/29850/1591833290-avatar512.jpg?auto=format&fm=png&h=32&mask=ellipse&w=32","srcSet":"https://www.datocms-assets.com/29850/1591833290-avatar512.jpg?auto=format&dpr=1&fm=png&h=32&mask=ellipse&w=32 1x,\nhttps://www.datocms-assets.com/29850/1591833290-avatar512.jpg?auto=format&dpr=1.5&fm=png&h=32&mask=ellipse&w=32 1.5x,\nhttps://www.datocms-assets.com/29850/1591833290-avatar512.jpg?auto=format&dpr=2&fm=png&h=32&mask=ellipse&w=32 2x,\nhttps://www.datocms-assets.com/29850/1591833290-avatar512.jpg?auto=format&dpr=3&fm=png&h=32&mask=ellipse&w=32 3x"},"r48":{"src":"https://www.datocms-assets.com/29850/1591833290-avatar512.jpg?auto=format&fm=png&h=48&mask=ellipse&w=48","srcSet":"https://www.datocms-assets.com/29850/1591833290-avatar512.jpg?auto=format&dpr=1&fm=png&h=48&mask=ellipse&w=48 1x,\nhttps://www.datocms-assets.com/29850/1591833290-avatar512.jpg?auto=format&dpr=1.5&fm=png&h=48&mask=ellipse&w=48 1.5x,\nhttps://www.datocms-assets.com/29850/1591833290-avatar512.jpg?auto=format&dpr=2&fm=png&h=48&mask=ellipse&w=48 2x,\nhttps://www.datocms-assets.com/29850/1591833290-avatar512.jpg?auto=format&dpr=3&fm=png&h=48&mask=ellipse&w=48 3x"}},"bio":"好き: TypeScript, DDD, OOP／#YYTypeScript の主催者／Qiita 4位／株式会社クラフトマンソフトウェア取締役／『実践ドメイン駆動設計』邦訳レビュア／#分報 考案者／Web自動テストShouldBeeを開発"},"date":"2015年10月14日","tags":["マイクロサービス","多言語","エラーメッセージ"],"category":"プログラミング","body":"\"image.png\n

マイクロサービスがREST APIを提供するようなアーキテクチャを組んだ場合でも、
\nマイクロサービスで発生したエラーをエンドユーザに何らかの形を通知する必要があります。

\n

技術的なシステムエラーであれば詳しく通知しないこともありますが、
\n「購入しようとした商品がちょうど売り切れてしまって購入できなかった」といったようなドメインエラーは、
\n必要十分にユーザに知らせる必要が出てきます。

\n

特に、多言語対応・地域対応まで念頭におくと、翻訳もしなければなりません。
\nでは、翻訳の責務はマイクロサービスのサーバ・クライアントどちらにあるのでしょうか？

\n\"2.png\n

正解はシステムによって様々だと思います。
\nここでは、システムが採用できそうな責務の分担パターンを5つ紹介したいと思います。

\n
    \n
  1. モノリンガル
    \n1.マルチリンガル
    2. \n
  2. セマンティック
    3. \n
  3. フォーマットメッセージ
    4. \n
  4. ハイブリッドレスポンス
    5. \n
\n

\n > 1. モノリンガル1. モノリンガル

\n

英語など特定の言語のメッセージしか返さないサービス。翻訳の責務はクライアントが負う。

\n

\n > リクエスト例リクエスト例

\n
\n
\nhttp
\n
POST /users HTTP/1.1\nHost: account.services.example.com\nContent-Length: 69\nContent-Type: application/json; charset=utf-8\n\n{\n  \"username\": \"a\",\n  \"email\": \"foo@example.com\",\n  \"password\": \"p@ssW0rd\"\n}\n
\n
\n

\n > レスポンス例レスポンス例

\n
\n
\nhttp
\n
HTTP/1.1 400 Bad Request\nContent-Type: application/json; charset=UTF-8\n\n{\n  \"message\": \"Username is too short (minimum is 3 characters)\"\n}\n
\n
\n

\n > モノリンガルのメリットモノリンガルのメリット

\n\n

\n > モノリンガルのデメリットモノリンガルのデメリット

\n\n

\n > 2. マルチリンガル2. マルチリンガル

\n

クライアントのAccept-Languageにしたがって、言語を切り替えるサービス。
\n翻訳の責務はサーバが負う。
\n例えば、Facebook APIはユーザの言語設定を見て切り替えている。

\n

\n > リクエスト例リクエスト例

\n
\n
\nhttp
\n
POST /users HTTP/1.1\nHost: account.services.example.com\nContent-Length: 69\nContent-Type: application/json; charset=utf-8\nAccept-Language: ja-JP,ja;q=0.9,en-US;q=0.7,en;q=0.5\n\n{\n  \"username\": \"a\",\n  \"email\": \"foo@example.com\",\n  \"password\": \"p@ssW0rd\"\n}\n
\n
\n

\n > レスポンス例レスポンス例

\n
\n
\nhttp
\n
HTTP/1.1 400 Bad Request\nContent-Type: application/json; charset=UTF-8\nContent-Language: ja\n\n{\n  \"message\": \"ユーザ名が短すぎます。(最低3文字)\"\n}\n
\n
\n

\n > マルチリンガルのメリットマルチリンガルのメリット

\n\n

\n > マルチリンガルのデメリットマルチリンガルのデメリット

\n\n

\n > 3. セマンティック3. セマンティック

\n

特定の言語を返さず、エラーコードなど意味的なエラー情報のみを返すサービス。
\n翻訳の責務はクライアントが負う。

\n

\n > リクエスト例リクエスト例

\n
\n
\nhttp
\n
POST /users HTTP/1.1\nHost: account.services.example.com\nContent-Length: 69\nContent-Type: application/json; charset=utf-8\n\n{\n  \"username\": \"a\",\n  \"email\": \"foo@example.com\",\n  \"password\": \"p@ssW0rd\"\n}\n
\n
\n

\n > レスポンス例レスポンス例

\n
\n
\nhttp
\n
HTTP/1.1 400 Bad Request\nContent-Type: application/json; charset=UTF-8\n\n{\n  \"code\": \"username.too_short\",\n  \"values\": {\n    \"minimum\": \"3\"\n  }\n}\n
\n
\n

クライアントは、username.too_short → 日本語「ユーザ名は{minimum}文字以下にしてください」といったマップを持っている。

\n

\n > セマンティックのメリットセマンティックのメリット

\n\n

\n > セマンティックのデメリットセマンティックのデメリット

\n\n

\n > 4. フォーマットメッセージ4. フォーマットメッセージ

\n

モノリンガルと同じく英語など特定の言語のメッセージしか返さないが、テキスト処理を容易にした中間的なメッセージオブジェクトを返すサービス。
\n翻訳の責務はクライアントが負う。

\n

\n > リクエスト例リクエスト例

\n
\n
\nhttp
\n
POST /users HTTP/1.1\nHost: account.services.example.com\nContent-Length: 69\nContent-Type: application/json; charset=utf-8\n\n{\n  \"username\": \"a\",\n  \"email\": \"foo@example.com\",\n  \"password\": \"p@ssW0rd\"\n}\n
\n
\n

\n > レスポンス例レスポンス例

\n
\n
\nhttp
\n
HTTP/1.1 400 Bad Request\nContent-Type: application/json; charset=UTF-8\n\n{\n  \"message\": \"Username is too short (minimum is {{minimum}} characters)\",\n  \"values\": {\n    \"minimum\": \"3\"\n  }\n}\n
\n
\n

\n > フォーマットメッセージのメリットフォーマットメッセージのメリット

\n\n

\n > フォーマットメッセージのデメリットフォーマットメッセージのデメリット

\n\n

\n > 5. ハイブリッドレスポンス5. ハイブリッドレスポンス

\n

最終的な翻訳の責務はクライアントが負うが、
\n翻訳の自由度、翻訳をしないという選択の自由をクライアントに与えるサービス。モノリンガル・セマンティック・フォーマットメッセージを組み合わせたもの。

\n

\n > リクエスト例リクエスト例

\n
\n
\nhttp
\n
POST /users HTTP/1.1\nHost: account.services.example.com\nContent-Length: 69\nContent-Type: application/json; charset=utf-8\n\n{\n  \"username\": \"a\",\n  \"email\": \"foo@example.com\",\n  \"password\": \"p@ssW0rd\"\n}\n
\n
\n

\n > レスポンス例レスポンス例

\n
\n
\nhttp
\n
HTTP/1.1 400 Bad Request\nContent-Type: application/json; charset=UTF-8\n\n{\n  \"code\": \"username.too_short\",\n  \"message\": \"Username is too short (minimum is 3 characters)\",\n  \"format\": \"Username is too short (minimum is {{minimum}} characters)\",\n  \"values\": {\n    \"minimum\": \"3\"\n  }\n}\n
\n
\n

\n > ハイブリッドレスポンスのメリットハイブリッドレスポンスのメリット

\n\n

\n > ハイブリッドレスポンスのデメリットハイブリッドレスポンスのデメリット

\n\n

\n > 翻訳データプロバイダ翻訳データプロバイダ

\n

セマンティックメッセージやフォーマットメッセージはクライアントが翻訳する必要があるというデメリットがある。
\n翻訳データプロバイダは、クライアントが翻訳エンジンを実装するコストを抑えるために、サーバが協力する補助的な仕組み。

\n

例えば、セマンティックの場合、サーバはエラーコードと翻訳のマップをHTTPで公開・提供する。
\nクライアントはHTTP経由でサーバの翻訳データリソースにアクセスし、ダウンロードでき、
\nその翻訳マップをデフォルトとして利用することができる。

\n

\n > まとめまとめ

\n

マイクロサービスでエラーメッセージの翻訳の責務をどうしたらいいかについて、いくつかパターンを整理してみました。

\n

どれが正解というわけではないので、プロジェクトやシステムに合ったものを採用するといいかと思います。

\n"}},"pageContext":{"id":"DatoCmsPost-5142981-ja","description":"マイクロサービスがREST APIを提供するようなアーキテクチャを組んだ場合でも、 マイクロサービスで発生したエラーをエンドユーザに何らかの形を通知する必要があります。 技術的なシステムエラーであれば詳しく通知しないこともありますが、 「購入しようとした商品がちょうど売り切れてしまって購入できなかった」といったようなドメインエラーは、 必要十分にユーザに知らせる必要が出てきます。 特に、多言語対応・地域対応まで念頭におくと、翻訳もしなければなりません。 では、翻訳の責務はマイクロサービスのサーバ・クライアントどちらにあるのでしょうか？ 正解はシステムによって様々だと思います。 ここでは、システ","toc":[{"tag":"h1","depth":1,"href":"#1.%20%E3%83%A2%E3%83%8E%E3%83%AA%E3%83%B3%E3%82%AC%E3%83%AB","text":"1. モノリンガル","html":"1. モノリンガル"},{"tag":"h2","depth":2,"href":"#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E4%BE%8B","text":"リクエスト例","html":"リクエスト例"},{"tag":"h2","depth":2,"href":"#%E3%83%AC%E3%82%B9%E3%83%9D%E3%83%B3%E3%82%B9%E4%BE%8B","text":"レスポンス例","html":"レスポンス例"},{"tag":"h2","depth":2,"href":"#%E3%83%A2%E3%83%8E%E3%83%AA%E3%83%B3%E3%82%AC%E3%83%AB%E3%81%AE%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88","text":"モノリンガルのメリット","html":"モノリンガルのメリット"},{"tag":"h2","depth":2,"href":"#%E3%83%A2%E3%83%8E%E3%83%AA%E3%83%B3%E3%82%AC%E3%83%AB%E3%81%AE%E3%83%87%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88","text":"モノリンガルのデメリット","html":"モノリンガルのデメリット"},{"tag":"h1","depth":1,"href":"#2.%20%E3%83%9E%E3%83%AB%E3%83%81%E3%83%AA%E3%83%B3%E3%82%AC%E3%83%AB","text":"2. マルチリンガル","html":"2. マルチリンガル"},{"tag":"h2","depth":2,"href":"#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E4%BE%8B-1","text":"リクエスト例","html":"リクエスト例"},{"tag":"h2","depth":2,"href":"#%E3%83%AC%E3%82%B9%E3%83%9D%E3%83%B3%E3%82%B9%E4%BE%8B-1","text":"レスポンス例","html":"レスポンス例"},{"tag":"h2","depth":2,"href":"#%E3%83%9E%E3%83%AB%E3%83%81%E3%83%AA%E3%83%B3%E3%82%AC%E3%83%AB%E3%81%AE%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88","text":"マルチリンガルのメリット","html":"マルチリンガルのメリット"},{"tag":"h2","depth":2,"href":"#%E3%83%9E%E3%83%AB%E3%83%81%E3%83%AA%E3%83%B3%E3%82%AC%E3%83%AB%E3%81%AE%E3%83%87%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88","text":"マルチリンガルのデメリット","html":"マルチリンガルのデメリット"},{"tag":"h1","depth":1,"href":"#3.%20%E3%82%BB%E3%83%9E%E3%83%B3%E3%83%86%E3%82%A3%E3%83%83%E3%82%AF","text":"3. セマンティック","html":"3. セマンティック"},{"tag":"h2","depth":2,"href":"#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E4%BE%8B-2","text":"リクエスト例","html":"リクエスト例"},{"tag":"h2","depth":2,"href":"#%E3%83%AC%E3%82%B9%E3%83%9D%E3%83%B3%E3%82%B9%E4%BE%8B-2","text":"レスポンス例","html":"レスポンス例"},{"tag":"h2","depth":2,"href":"#%E3%82%BB%E3%83%9E%E3%83%B3%E3%83%86%E3%82%A3%E3%83%83%E3%82%AF%E3%81%AE%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88","text":"セマンティックのメリット","html":"セマンティックのメリット"},{"tag":"h2","depth":2,"href":"#%E3%82%BB%E3%83%9E%E3%83%B3%E3%83%86%E3%82%A3%E3%83%83%E3%82%AF%E3%81%AE%E3%83%87%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88","text":"セマンティックのデメリット","html":"セマンティックのデメリット"},{"tag":"h1","depth":1,"href":"#4.%20%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%83%E3%83%88%E3%83%A1%E3%83%83%E3%82%BB%E3%83%BC%E3%82%B8","text":"4. フォーマットメッセージ","html":"4. フォーマットメッセージ"},{"tag":"h2","depth":2,"href":"#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E4%BE%8B-3","text":"リクエスト例","html":"リクエスト例"},{"tag":"h2","depth":2,"href":"#%E3%83%AC%E3%82%B9%E3%83%9D%E3%83%B3%E3%82%B9%E4%BE%8B-3","text":"レスポンス例","html":"レスポンス例"},{"tag":"h2","depth":2,"href":"#%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%83%E3%83%88%E3%83%A1%E3%83%83%E3%82%BB%E3%83%BC%E3%82%B8%E3%81%AE%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88","text":"フォーマットメッセージのメリット","html":"フォーマットメッセージのメリット"},{"tag":"h2","depth":2,"href":"#%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%83%E3%83%88%E3%83%A1%E3%83%83%E3%82%BB%E3%83%BC%E3%82%B8%E3%81%AE%E3%83%87%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88","text":"フォーマットメッセージのデメリット","html":"フォーマットメッセージのデメリット"},{"tag":"h1","depth":1,"href":"#5.%20%E3%83%8F%E3%82%A4%E3%83%96%E3%83%AA%E3%83%83%E3%83%89%E3%83%AC%E3%82%B9%E3%83%9D%E3%83%B3%E3%82%B9","text":"5. ハイブリッドレスポンス","html":"5. ハイブリッドレスポンス"},{"tag":"h2","depth":2,"href":"#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E4%BE%8B-4","text":"リクエスト例","html":"リクエスト例"},{"tag":"h2","depth":2,"href":"#%E3%83%AC%E3%82%B9%E3%83%9D%E3%83%B3%E3%82%B9%E4%BE%8B-4","text":"レスポンス例","html":"レスポンス例"},{"tag":"h2","depth":2,"href":"#%E3%83%8F%E3%82%A4%E3%83%96%E3%83%AA%E3%83%83%E3%83%89%E3%83%AC%E3%82%B9%E3%83%9D%E3%83%B3%E3%82%B9%E3%81%AE%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88","text":"ハイブリッドレスポンスのメリット","html":"ハイブリッドレスポンスのメリット"},{"tag":"h2","depth":2,"href":"#%E3%83%8F%E3%82%A4%E3%83%96%E3%83%AA%E3%83%83%E3%83%89%E3%83%AC%E3%82%B9%E3%83%9D%E3%83%B3%E3%82%B9%E3%81%AE%E3%83%87%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88","text":"ハイブリッドレスポンスのデメリット","html":"ハイブリッドレスポンスのデメリット"},{"tag":"h1","depth":1,"href":"#%E7%BF%BB%E8%A8%B3%E3%83%87%E3%83%BC%E3%82%BF%E3%83%97%E3%83%AD%E3%83%90%E3%82%A4%E3%83%80","text":"翻訳データプロバイダ","html":"翻訳データプロバイダ"},{"tag":"h1","depth":1,"href":"#%E3%81%BE%E3%81%A8%E3%82%81","text":"まとめ","html":"まとめ"}],"ogpImageUrl":"https://www.datocms-assets.com/29850/1593190022-pastedimage20200627146.png?fm=png&mark64=aHR0cHM6Ly93d3cuZGF0b2Ntcy1hc3NldHMuY29tLzI5ODUwLzE1OTMxNTQ2MzYtdHJhbnNwYXJlbnQtcGl4ZWwucG5nP3c9NDAwJmg9NjQmZml0PWNyb3AmYmxlbmQ2ND1hSFIwY0hNNkx5OTNkM2N1WkdGMGIyTnRjeTFoYzNObGRITXVZMjl0THpJNU9EVXdMekUxT1RFNE16TXlPVEF0WVhaaGRHRnlOVEV5TG1wd1p6OXRZWE5yUFdWc2JHbHdjMlVtWm0wOWNHNW5KbmM5TWpVMkptZzlNalUyJmJsZW5kLWg9NjQmYmxlbmQteD0wJmJsZW5kLXk9MCZibGVuZC1tb2RlPW5vcm1hbCZtYXJrNjQ9YUhSMGNITTZMeTloYzNObGRITXVhVzFuYVhndWJtVjBMMzUwWlhoMFAzUjRkQzFoYkdsbmJqMXRhV1JrYkdVbE1rTnNaV1owSm5SNGRDMW1iMjUwUFhOaGJuTXRjMlZ5YVdZbE1rTmliMnhrSm5SNGRDMWpiMnh2Y2oweU1qRTRNVFltZEhoME5qUTlZek5XY0dKbkpuUjRkQzF6YVhwbFBUTXdKbWc5TmpRJm1hcmsteD02NCZtYXJrLWFsaWduPW1pZGRsZSUyQ2xlZnQ&mark-align=bottom%2Cleft&mark-x=100&mark-y=496&blend64=aHR0cHM6Ly93d3cuZGF0b2Ntcy1hc3NldHMuY29tLzI5ODUwLzE1OTMxNTQ2MzYtdHJhbnNwYXJlbnQtcGl4ZWwucG5nP3c9MTIwMCZoPTYzMCZmaXQ9Y3JvcCZtYXJrNjQ9YUhSMGNITTZMeTkzZDNjdVpHRjBiMk50Y3kxaGMzTmxkSE11WTI5dEx6STVPRFV3THpFMU9UTXhOVEE1TkRBdFkzSmhablJ6YldGdUxUQXhMbkJ1WncmbWFyay1hbGlnbj10b3AlMkNjZW50ZXImbWFyay13PTI1MCZtYXJrLXk9ODAmYmxlbmQ2ND1hSFIwY0hNNkx5OWhjM05sZEhNdWFXMW5hWGd1Ym1WMEwzNTBaWGgwUDNSNGRDMWhiR2xuYmoxdGFXUmtiR1VsTWtOalpXNTBaWEltZEhoMExXWnZiblE5YzJGdWN5MXpaWEpwWmlVeVEySnZiR1FtZEhoMExYQmhaRDB4TURBbWRIaDBMV052Ykc5eVBUSXlNVGd4TmlaMGVIUTJORDAyU1hWNE5rdHhaVGMzZVdZMWNHVnNOWEI1Y3paTGNXVTNOM2xtTkRSUFpUUTBTMnMwTkV0Mk5EUlBkRFEwU3pFME5FODRORFJQVkRRMFN6VTBORWQxTkRSTGJ6UTBUM0EwTkU4NE5EUlBhRFEwVDBRME5FczNORFJQT0RRMFN6UTBORWQyTlV3eVZqWkxjV1UwTkVkTk5rbHRkalEwUjBVM04zbG1KblI0ZEMxemFYcGxQVFUxSm5jOU1USXdNQ1pvUFRZek1BJmJsZW5kLW1vZGU9bm9ybWFs&blend-mode=normal","otherPost":{"type":"author","title":"30分間React入門「いいねボタン」作成チュートリアル！","slug":"/posts/47"}}}}