zoukankan      html  css  js  c++  java
  • 如何写一个好的接口

    1.try{}catch{} 中的exception:

       异常,不要吞掉,该throw的应该throw出来,由项目统一的ExceptionHandler统一处理

      尽量丰富throw出的exception信息

      日志记录

    2.webapi项目

      返回、传参:类型明确,非object、IActionResult

        MVC项目,返回IActionResult

        利于,返回类型统一:调用者不会产生疑惑(string or  list<entity>)

        请求、响应是唯一的

      [ExceptionHandler or ResultHandler]来对项目的throw异常进行统一的处理

    3.Proxy代理模式:

      1.对各个平台的调用屏蔽了细节。调用者不用了解不同平台的细节,可以很快实现相关功能

      2.隐藏了authentic的细节,防止外部调用者的错误操作,造成严重事故

    4.注意项目的层次分明

      1.数据库操作层

      2.外部api的代理层

      3.业务逻辑层

      4.分层、方法构建:

        考虑如何使调用者用最少的学习成本,来完成接口的调用,实现应有的功能

        层次多了 or 少了

        分层是否合理:架构、逻辑、业务

    5.那些东西可以放在公共项目中:Common项目

      定义不会产生歧义的。产生歧义的(付款方、打款方,不同角色的理解不同)

      大家都会使用的公共的方法、类

        

      

      

  • 相关阅读:
    349. Intersection of Two Arrays
    346. Moving Average from Data Stream
    345. Reverse Vowels of a String
    344. Reverse String
    342. Power of Four
    POJ2823 Sliding Window
    《STL源码剖析》笔记
    [jobdu]扑克牌顺子
    [jobdu]第一个只出现一次的字符
    [jobdu]包含min函数的栈
  • 原文地址:https://www.cnblogs.com/panpanwelcome/p/8184107.html
Copyright © 2011-2022 走看看