事情中，少不了要界说各类接口，系统集成要界说接口，前靠山掉挪用也要界说接口。接口界说必然水平上能回响措施员的编程功底。罗列一下事情中我发明各人容易呈现的问题：

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，aop才好做。有些人误解了，我那篇文章说的都不是技能，软件开发，重点说的是编码习惯事情方法，假如你重点照旧放在什么技能上，那我也帮不了你了。同样，假如我后头的关于习惯和类型的帖子，你重点照旧放在技能上的话，那是丢了西瓜捡芝麻，软件开发，有许多贴照旧没有任何技能点呢。

附上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 ;
  }
}

统一的接口类型，能资助规避许多无用的返工修改和大概呈现的问题。能使代码可读性越发好，利于举办aop和自动化测试这些特别事情。各人必然要重视。