您的位置 首页 java

java实战–写接口

企业工作的需求:写接口

接口第一个含义是: 写http请求 或者其他如webservice ,hessian这些

接口第二个含义: 写的就是个java的interface接口

基于serverlet请求一般对应响应 request 对应响应 response; 返回的参数最终都是string的形式返回,一般都喜欢用比如fastJSON Gson这样的toString一下返回;默认是使用jackson的序列化操作的;其他的如protobufuff? xml这样的,遇到xml这样的返回也无需担心,实在不会了直接用StringBuilder这样的类进行append拼接,另外一种方式就是模板化格式返回或者一些工具类转换

通常操作都是增删改查 外加导入导出和统计;多一点就是写个byXX

addXXX

updateXXX

deleteXXX

searchXXList

importXXX

exportXXX

countXXX

注意:请求参数不要带一些特殊的东西,如delete update等等特殊的,框架中可能会影藏一些过滤的来过滤这些特殊字符;如果方法命名不允许这样的,可以改成其他方式的命名,但大体是符合项目要求(符合当前项目规定的)

那写接口需要注意哪些,http的”接口”,即请求url,尽量使用post请求,见名知意(项目规范来,有些不一定是按这个来的)下面实例一个

一个是写在controller返回的,一个是写在方法上的,一般都是@RequestMapping 有些指定方法的如:@PostMapping 需要看具体工程规范一般两个都可以用

value值,避免重复

SpringMVC中:这个地方是被处理器映射器解析

java实战--写接口

http请求

需要try catch 么 看项目,有些做了全局异常解析器统一返回异常,有些则是项目中的,如返回一个构造对象

interface接口

 /**
 * 校验服务
 */
public interface ICheckService {
    boolean checkParam(CheckConfig checkConfig, Map<String,String> map);
}  

方法命名规范,可以看前面中关于方法的介绍 :此处略提: 返回值 方法名(动词开头,代表行动) 参数列表(有些地方使用map会更通用一些(个人习惯),另外就是对象充分使用,java语言本身就是个对象语言)

接口尽量遵循一些原则,比较多书籍写到的

开闭原则:对扩展开放,对修改关闭

依赖倒置:抽象不应依赖细节,细节依赖抽象

单一职责 :接口功能职责明确,不写一个接口对个职责,不利于维护即做什么比较单一

接口隔离:用多个专门的接口,而不是单一的接口 (主要有多实现这个implements),写小的接口不写大的(大的指方法贼多的接口)

迪米特:最少知道原则

里氏替换:一句话,多态运用,其他写的比这里多

合成复用:主要将的是尽量组合,达到内聚 常用Autowired Resource注解作用理解就是这个

一句话总结:就是尽量写的简单的,小的接口 这样避免工作踩坑;可能有时你的确无法避免这样大的接口,那可能都是写古董代码

万不得已不要轻易改别人的接口,因为没出问题好,出问题就是你背锅,搞不好造成重大生产问题被开除(见过别人干过这样的事情)

其他的需要考虑的可能会涉及设计模式,此处不再引申,如果要实战的话,建议可以看看《研磨设计模式》,或者多看看spring的源码设计以及常用的工具类中的一些写法,这样对于写代码的提升会是比较快的

w3cschool,菜鸟教程等等都有这些讲解

好了,即将踏入工作的你异或是已经工作的你,将逐步领悟

文章来源:智云一二三科技

文章标题:java实战–写接口

文章地址:https://www.zhihuclub.com/174877.shtml

关于作者: 智云科技

热门文章

网站地图