amox-http_软件总体设计文档 - 笔记

前言

做Java也有三年了，一直想自己做个东西出来，于是第一个想到的是做一个自动生成代码的工具，在添加webService服务功能时，想到再添加一个http服务功能，但java添加http服务很麻烦，由此产生的此软件，此软件是自动生成代码工具的附属工具。

我们都知道java的web项目可以对外发布webService服务和http服务，通过xfire只可以很方便的发布webService服务，但是java发布http服务一直不方便。通过java原生的servlet发布http服务可以方便其它平台调用，但是编程比较麻烦而且不太适合目前的j2ee的编程思想，此方式不太合适；通过spring的http-invorke发布的http服务，可以方便快速，但在客户端必须依赖spring本身才能调用，在移动平台火爆的今天许多移动平台原生支持http调用，此种http服务的发布方式显然也不合适；为达到目前j2ee的编程思想并且能方便快速用于其它平台的调用为此产生了本软件

（amox-http），本软件可以方便快速的发布http服务，可以跨平台调用。系统概述

（1）本软件就是HTTP服务发布工具包；

（2）主要功能使用本软件能方便快捷发布一个基于java的spring的HTTP服务。

（3）工作原理：

a)在web工程启动时，加载类

com.amox.http.spring.HttpServiceSpringRegister（http服务注册类）中

注册的serviceBeans（需要发布服务的类）；加载时只会把服务类中加了

@PathMapping的注解的方法发布成服务载入内存；

b)用户请求时，拦截类com.amox.http.spring.HttpServiceSpringDispatcher

拦截获取用户请求的路径，获取用户请求的路径；

c)根据用户的请求路径匹配对应的服务，若存在对应服务则返回对应方法返回

值，若不存在给出错误提示。

实践

提示：本软件是基于spring开发，所以要有spring包（非spring方式暂未提供，正在设计调用方式），本软件的核心是反射所以还要有一个核心jar包javassist.jar

1. 载入jar包（amox-http-1.7.jar）

https://www.360docs.net/doc/9415199878.html,/detail/qi_w2006/4971419

2. 载入jar包（javassist.jar）

https://www.360docs.net/doc/9415199878.html,/detail/qi_w2006/4971428

3. 配置web.xml如下：

AmoXHttpServlet

com.amox.http.spring.HttpServiceSpringDispatcher

AmoXHttpServlet

/http/*

4. 配置spring-http.xml（此文件名为spring配置文件，可自定义需要的名称）配置文件如下：

5. 编写需要发布的服务类，如下：

public interface HttpServiceDemo {

/**

* 发布GET服务

* 建议参数中不用基本类型，这样若请求中可不传此参数

* @param request 请求参数

* @param index 请求参数

* @return 服务结果

*/

public String demoGet(String request, Long index);

/**

* 发布POST服务

* 建议参数中不用基本类型，这样若请求中可不传此参数

* @param request 请求参数

* @param index 请求参数

* @return 服务结果

*/

public String demoPost(String request, Double index);

/**

* 发布GET和POST服务

* 建议参数中不用基本类型，这样若请求中可不传此参数

* @param request 请求参数

* @param index 请求参数

* @return 服务结果

*/

public String demoBoth(String request, Integer index);

}

public class HttpServiceDemoImpl implements HttpServiceDemo { @Autowired

private HttpBmo httpBmo;

@PathMapping("/demoGetService")

public String demoGet(String request, Long index) {

return "demoGetService : " + httpBmo.demo(request, index);

}

@PathMapping(value="/demoPostService", method=RequestMethod.POST) public String demoPost(String request, Double index) {

return "demoPostService : " + httpBmo.demo(request, index);

}

@PathMapping(value="/demoBothService", method={RequestMethod.POST, RequestMethod.GET} )

public String demoBoth(String request, Integer index) {

return "demoBothService : " + httpBmo.demo(request, index);

}

}

public interface HttpBmo {

public String demo(String request, Number index);

}

import org.springframework.stereotype.Service;

@Service

public class HttpBmoImpl implements HttpBmo {

@Override

public String demo(String request, Number index) {

return "{request : "+request

+", index : " + index + "}";

}

}

5. 访问服务，如下：

6. 好的教程不如好的文档

https://www.360docs.net/doc/9415199878.html,/detail/qi_w2006/4971446

生成的文档中，枚举类RequestMethod生成的文档有问题，说是jdk1.6的BUG会在7中解决。。。

7. 好的文档不如好的例子

https://www.360docs.net/doc/9415199878.html,/detail/qi_w2006/4971395

8. 如果没有积分可以访问我在有道云笔记的分享

https://www.360docs.net/doc/9415199878.html,/share/?id=33d7766911bb20fb3c99ec07a40827 12&type=note

后记

今天刚好是1月7号，是我阳历的生日，从开始写这个包到发布不至7－8次吧，虽然一共才花了4天不到的时间，版本为1.7，后期上2.0添加非spring 支持发布http服务，到时有时间再把设计文档补充下。

^_^!