インタフェース仕様は何と言いたいですか.

2018 ワード

JAvaサービス型RPCフレームワークで選択されるリモートコール方式には、jarパッケージと純REST方式の2つのスタイルがあります.
JArパッケージ方式の利点は、相手が提供した2つのパッケージを使って、APIが中に入っていて、使用時に直接ヒントをポップアップすることができます.問題も明らかで、参照されるjarパケットが多くなるにつれて、パケットの並べ替え作業が半分を占めています.
REST方式はHTTPプロトコルをキャリアとして直接データを伝達し、呼び出し元との関係を徹底的にデカップリングした.しかし、jarパッケージのようにIDEから使用ヒントを簡単にポップアップすることはできません.まず、相手がくれたドキュメントを見なければなりませんが、プログラマーが書いたドキュメントはみんな知っています.最後には口舌でコミュニケーションする必要があります.この方面の微信のオープンプラットフォームで作ったドキュメントは悪くない.
技術責任者は、使用する開発者の応用詳細をできるだけ考慮し、開発者への干渉をできるだけ減らすべきである.大規模なチームのコミュニケーション効率を高めるためには、開発者の自由な発揮空間を制約する開発規範を制定する必要がある.
統一されたWEB APIを定義して結果を返すと、最も簡単で直接的なのは制約がなく、各種のオープンソースフレームワークの標準的な返信を使用することであり、基礎フレームワークは基本機能のパッケージであるため、勝手に開発してどのように書くかである.
JAva servletにはHttpResponseがあります.
いくつかのjsonシーケンス化形式の戻りを使用すると、json形式は次のようになります.
{
  "weather": normal,
  "area" : hangzhou,
}

この戻りは簡単ですが、勝手に、大規模な工事ではすべての人が同じ規範を守って仕事をしたいと思っています.例えば、この戻りが間違っていたら何を返すべきですか.
  • また開発して自分で勝手にstatus:errorを決めますか?
  • 結果がerrorになったら、フロントエンドに戻りコードを追加しませんか?例えばerrorcode:1
  • では、この1はどういう意味ですか.errorcodeを0とデフォルトで設定できるのは普通ですか?
  • さらに次のステップでは、errorがあれば、フロントエンドには一般的にXXXXエラーなどのヒントが必要です.この詳細はまたerrormessageを注文しますか?

  • エラーの戻りは次のようになります.
    {
      "status": 1
      "errorcode": 202
      "errormessage" :      
    }

    こうなった以上、正しい戻りはあまり勝手にはできません.これについて、正常な戻りはこうなるかもしれません.
    {
      "status":0,
      "body":{
      "weather": normal,
      "area" : hangzhou,
      }
    }

    このような効果を達成するために、設計者は開発を簡単に
    String jsonInString = mapper.writeValueAsString(staff);
    この形式で遊びに来ました.汎用的な解決策が必要です.
    オープンプラットフォームの対外インタフェース設計は重要なものであり、簡単さ、拡張性、読みやすさを考慮しなければならない.ここでは、APIインタフェースの設計方法については説明しません.まず、設定規範の考え方についてお話しします.まず、一般の開発者に感知されないようにしたいと思います.では、responseに戻った後、彼の結果に何かをし、切り込み点を探し、どんな内容を返しても、httpヘッダに似たものをパッケージし、今回の要求の状態情報を含めなければなりません.
    reponse class-> json -> [head]+json
    これにより、チームが標準化された後、個人の成果物は標準セットであり、チームの成果物は全体である.私たちは誰もが散兵遊勇ではなく、集団化作戦であることを望んでいる.このような細かいことは後で別のことを考えてから話しましょう.