当前位置: article > 正文

Java接口定义规范，摘自晓风轻专栏_java定义接口规范_关于java的接口的一些规范

作者：羊村懒王 | 2024-02-28 06:09:06

踩

java定义接口规范_关于java的接口的一些规范

1. 返回格式不统一

同一个接口，有时候返回数组，有时候返回单个；成功的时候返回对象，失败的时候返回错误信息字符串。工作中有个系统集成就是这样定义的接口，真是辣眼睛。这个对应代码上，返回的类型是map，json，object，都是不应该的。实际工作中，我们会定义一个统一的格式，就是ResultBean，分页的有另外一个PageResultBean

错误范例：


 //返回map可读性不好，尽量不要
　＠PostMapping("/delete")
  public Map<String, Object> delete(long id, String lang) {
 
  }
 
  // 成功返回boolean，失败返回string，大忌
  ＠PostMapping("/delete")
  public Object delete(long id, String lang) {
    try {
      boolean result = configService.delete(id, local);
      return result;
    } catch (Exception e) {
      log.error(e);
      return e.toString();
    }
  }

2. 没有考虑失败情况

一开始只考虑成功场景，等后面测试发现有错误情况，怎么办，改接口呗，前后台都改，劳民伤财无用功。

错误范例：


 //不返回任何数据，没有考虑失败场景，容易返工
　＠PostMapping("/update")
  public void update(long id, xxx) {
 
  }

3. 出现和业务无关的输入参数

如lang语言，当前用户信息都不应该出现参数里面，应该从当前会话里面获取。后面讲ThreadLocal会说到怎么样去掉。除了代码可读性不好问题外，尤其是参数出现当前用户信息的，这是个严重问题。

错误范例：


 // （当前用户删除数据）参数出现lang和userid，尤其是userid，大忌
　＠PostMapping("/delete")
  public Map<String, Object> delete(long id, String lang, String userId) {
 
  }

4. 出现复杂的输入参数

一般情况下，不允许出现例如json字符串这样的参数，这种参数可读性极差。应该定义对应的bean。

错误范例：


 // 参数出现json格式，可读性不好，代码也难看
　＠PostMapping("/update")
  public Map<String, Object> update(long id, String jsonStr) {
 
  }

5. 没有返回应该返回的数据

例如，新增接口一般情况下应该返回新对象的id标识，这需要编程经验。新手定义的时候因为前台没有用就不返回数据或者只返回true，这都是不恰当的。别人要不要是别人的事情，你该返回的还是应该返回。

错误范例：


 // 约定俗成，新建应该返回新对象的信息，只返回boolean容易导致返工
　＠PostMapping("/add")
  public boolean add(xxx) {
    //xxx
    return configService.add();
  }

附上ResultBean，没有任何技术含量：


＠Data
public class ResultBean<T> implements Serializable {
 
  private static final long serialVersionUID = 1L;
 
  public static final int SUCCESS = 0;
 
  public static final int FAIL = 1;
 
  public static final int NO_PERMISSION = 2;
 
  private String msg = "success";
 
  private int code = SUCCESS;
 
  private T data;
 
  public ResultBean() {
    super();
  }
 
  public ResultBean(T data) {
    super();
    this.data = data;
  }
 
  public ResultBean(Throwable e) {
    super();
    this.msg = e.toString();
    this.code = FAIL ;
  }
}

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/羊村懒王/article/detail/157980