http接口开发与调用案例[通俗易懂]

2022-08-28 12:52:53 浏览数 (1)

大家好,又见面了,我是你们的朋友全栈君。

本打算上周末要在家里写这篇博客的,无奈没有控制住自己的拖延症,一直拖到周一,但下定决心,这篇文章一定要发表出来的。 在以前做的的ITOO项目中,模块之间的调用使用的EJB的session bean,貌似是EJB对分布式事务支持的比较好,但也深受其害。比如A模块想要调用B模块,需要依赖B模块的实体。在A模块中,通过JNDI到B模块的服务器查找依赖的service bean,所以A模块想要调用B模块,即需要依赖B模块的实体bean,还需要依赖B模块的service bean。这种方案造成的问题是,一旦B模块的某个bean出现问题,整个调用关系便中断。而且EJB的session bean对高可用负载均衡部署方案支持不是很好,调用关系不稳定。 对比EJB的session bean,现在我们采用spring boot微服务架构开发接口。接口开发前,由接口开发方和接口调用方定义接口规范,接口规范确定后同步到wiki。接口开发方和接口调用方根据接口规范双向开展工作。对于接口开发方,我们的接口开发方式如下:

代码语言:javascript复制
@Path("/***")
@Produces(MediaType.APPLICATION_JSON)
public class ***Resource { 
   

    @GET
    public ApiResponse list(@QueryParam("***") String ***, @DefaultValue("1") @QueryParam("***") int ***) {

        List<***DTO> *** = new ArrayList<>();

        ......

        return ApiResponseBuilder.ok().entity(***).build();
    }

}

list方法返回数据格式为ApiResponse实体,通过@Produces(MediaType.APPLICATION_JSON)注解,将实体转为json返回,ApiResponse实体内容如下:

代码语言:javascript复制
public class ApiResponse { 
   

    public static final Object EMPTY = "";

    private int status;

    private String message;

    private Object entity = EMPTY;

    /** * */
    public static class ApiResponseBuilder{ 
   

        private ApiResponse apiResponse;

        public ApiResponseBuilder(ApiResponse resp){
            this.apiResponse = resp;
        }

        public static ApiResponseBuilder ok(){

            return status(HttpServletResponse.SC_OK).msg("ok");
        }

        public static ApiResponseBuilder status(int status){
            ApiResponse resp = new ApiResponse();
            resp.setStatus(status);

            return new ApiResponseBuilder(resp);
        }

        public ApiResponseBuilder msg(String msg){
            this.apiResponse.setMessage(msg);
            return this;
        }

        public ApiResponseBuilder entity(Object entity){
            this.apiResponse.setEntity(entity);
            return this;
        }

        public ApiResponse build(){

            return apiResponse;
        }
    }

    public int getStatus() {
        return status;
    }

    public void setStatus(int status) {
        this.status = status;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public Object getEntity() {
        return entity;
    }

    public void setEntity(Object entity) {
        this.entity = entity;
    }
}

到此接口开发工作完成,然后我们运行spring boot的main方法,整个服务便跑起来了。对于接口如何支持高可用部署,可以参考高可用api接口网络部署方案 对于接口调用方,我们需要在application.properties配置下接口调用的url地址,代码级别,我们通过org.springframework.web.client.RestTemplate发起接口调用,我们的调用方式如下:

代码语言:javascript复制
@Value(value = "${url}")
private String url;

RestTemplate temp = new RestTemplate();

String json = temp.getForObject(url, String.class, "***");

JsonNode root = ***.getJsonNode(json);

Entity entity = ***.getEntityFromJsonNode(root);

采用如上方式的接口开发与调用,开发方和调用方都依赖接口规范,这样可以很大程度的减小接口开发方和调用方的耦合关系,同时使用spring boot微服务架构,可以方便的部署接口高可用集群。 希望我的分享可以帮助到您进步。

发布者:全栈程序员栈长,转载请注明出处:https://javaforall.cn/146211.html原文链接:https://javaforall.cn

0 人点赞