使用SpringMvc开发Android WebService接口入门教程

文章转载自：http://cloudbbs.org/forum.PHP?mod=viewthread&tid=31880

1.首先大家先创建一个JavaWeb项目

2.然后加入SpringMVC所依赖的jar包文件到WebRootWEB-INFlib 文件夹下，jar包含文件如下图

3.我们在WebRootWEB-INF 目录下创建一个spring-servlet.xml文件，粘入如下代码

XML代码

1. <?xml version="1.0" encoding="UTF-8"?>
2. <beans xmlns="http://www.springframework.org/schema/beans"
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mvc="http://www.springframework.org/schema/mvc"
4. xmlns:context="http://www.springframework.org/schema/context"
5. xsi:schemaLocation="http://www.springframework.org/schema/beans
6. http://www.springframework.org/schema/beans/spring-beans.xsd
7. http://www.springframework.org/schema/mvc
8. http://www.springframework.org/schema/mvc/spring-mvc.xsd
9. http://www.springframework.org/schema/context
10. http://www.springframework.org/schema/context/spring-context-3.0.xsd">
11. 
    
12. <!-- 指定Controller都在 com.controller包里-->
13. <context:component-scan base-package="com.springmvc.controller" />
14. <bean
15. class="org.springframework.web.servlet.view.InternalResourceViewResolver">
16. <property name="prefix" value="/" />
17. <property name="suffix" value=".jsp" />
18. </bean>
19. </beans>

4.我们现在在web.xml 下面粘入一下代码 简单配置一下SpringMvc

XML代码

1. <?xml version="1.0" encoding="UTF-8"?>
2. <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3. xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
4. xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
5. id="WebApp_ID" version="3.0">
6. <context-param>
7. <param-name>contextConfigLocation</param-name>
8. <!-- 应用上下文配置文件 -->
9. <param-value>/WEB-INF/spring-servlet.xml</param-value>
10. </context-param>
11. <listener>
12. <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
13. </listener>
14. <!-- 配置spring核心servlet -->
15. <servlet>
16. <servlet-name>spring</servlet-name>
17. <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
18. <load-on-startup>1</load-on-startup>
19. </servlet>
20. <!--
21. url-pattern配置为/，不带文件后缀，会造成其它静态文件(js，css等)不能访问。如配为*.do，则不影响静态文件的访问
22. -->
23. <servlet-mapping>
24. <servlet-name>spring</servlet-name>
25. <url-pattern>/</url-pattern>
26. </servlet-mapping>
27. </web-app>

现在呢我们的spring mvc项目就创建完成了，我们把web项目发布到本机tomcat里面，控制台出现如下输出并且没有报错证明你的spring mvc项目已经配置成功了。

接下来我们就可以开始编写接口了

我们首先创建Controller，由于我们之前在spring-servlet.xml文件里配置了指定Controller都在 com.springmvc.controller包里,所以我们要先创建com.springmvc.controller文件夹目录

XML代码

1. <!-- 指定Controller都在 com.springmvc.controller包里-->
2. <context:component-scan base-package="com.springmvc.controller" />

接下来我们就开始写springmvc 的controller了，我们就先写一个简单的WebService接口，给Android返回一句Hello SpringMVC！

新建一个名为HelloController.Java文件

Java代码

1. package com.springmvc.controller;
2. 
   
3. //朋友一定很好奇这个是干什么的，这个呢就是告诉spring这个类是Controller
4. @Controller
5. // 是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径
6. @RequestMapping("HelloController")
7. public class HelloController {
8. 
   
9. // value： 指定请求的实际地址；
10. // method： 指定请求的method类型， GET、POST、PUT、DELETE等；
11. @RequestMapping(value = "/hello.json", method = RequestMethod.GET)
12. // 该注解用于读取Request请求的body部分数据，使用系统默认配置的HttpMessageConverter进行解析，然后把相应的数据绑定到要返回的对象上；
13. @ResponseBody
14. // 那么我们要访问此方法是 完整路径应该是http://ip地址:端口/SpringMVC/HelloController/hello.json
15. public Object hello() {
16. return "Hello SpringMVC!";
17. }
18. }

写完了之后我们发不到tomcat中，本地测试时可以在浏览器输入127.0.0.1:8080/SpringMVC/HelloController/hello.json进行访问

输出结果就为 Hello SpringMVC!

想必你对编写Android接口已经有一定了解了，那么接下来我们正式开始编写一个简单Android应用的接口吧

首先我们应用有一个登录页面，那么我们服务端就要为这个应用登录功能提供一个登录接口

那么我们先来创建一个LoginController，我们就在这里面来编写登录接口

再想想登录成功我们肯定要给用户返回当前登录用户的信息比如用户名等…那么我们也要同时再创建一个用户实体类名字叫UserEntity

那我们先定义一下UserEntity里面所需要的字段吧

Java代码

1. package com.springmvc.entity;
2. public class UserEntity {
3. private String username;// 用户名
4. private String password;// 密码
5. private String nickname;// 昵称
6. private String gender;// 性别
7. private String age;// 年龄
8. get set 方法就省略了
9. }

接下来我们来编写LoginController的登录接口

Java代码

1. package com.springmvc.controller;
2. 
   
3. //这一步肯定少不了，前面有介绍就不再介绍了
4. @Controller
5. // 定义访问登录接口的父路径，前面有介绍也不多介绍了
6. @RequestMapping("LoginController")
7. public class LoginController {
8. 
   
9. // 路径参数{name}填入用户名，{pass}填入密码。我们设置为GET请求。
10. @RequestMapping(value = "/login_get.json/{name}/{pass}", method = RequestMethod.GET)
11. // 先前介绍过，就不再介绍了。
12. @ResponseBody
13. // 当使用@RequestMapping URI template 样式映射时， 即 /login_get.json/{name}/{pass},
14. // 这时的name和pass可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。
15. public Object login(@PathVariable String name, @PathVariable String pass) {
16. // 我们这里为了简单就不去数据库查询了（真正开发时候这里就要把传过来的用户名和密码带到数据库里进行查询）
17. // 假如我们数据库里用户名是admin密码为123456
18. if (name.equals("admin") && pass.equals("123456")) {
19. // 到了这里就说明我们登录成功了，这时候我们就要给Android端返回这个用户的信息
20. // 这里我们也就先写假数据了
21. UserEntity entity = new UserEntity();
22. entity.setUsername("admin");
23. entity.setPassword("123456");
24. entity.setNickname("张三");
25. entity.setGender("男");
26. entity.setAge("22");
27. 
    
28. return entity;// 此时返回此用户实体类
29. } else {
30. Map map = new HashMap();
31. map.put("msg", "登录失败，请检查用户名和密码是否正确");
32. 
    
33. return map;// 登录失败给Android端返回一个错误消息提醒用户
34. }
35. }
36. }

由于是GET访问，我们可以直接用浏览器访问 输入正确的用户名和密码，我们看下图当前用户实体自动转换为json字符串了，这时拿到json字符串就好办了，我们Android端就可以进行解析此json并且拿到当前用户的信息了。

那我们再输入错误的用户名和密码时，我们看下图，返回的json字符串告诉我们可能输入的信息有误，这时我们Android端也可以进行解析json然后给用户提示我们服务端返回的提示信息告诉用户检查输入的信息是否正确了。 

我们有了登录功能那么肯定就少不了注册功能，接下来我们再来写一个注册功能

那么我们先来创建一个RegisteredController，我们就在这里面来编写注册接口

Java代码

1. package com.springmvc.controller;
2. 
   
3. import java.util.HashMap;
4. import java.util.Map;
5. 
   
6. import org.springframework.stereotype.Controller;
7. import org.springframework.web.bind.annotation.ModelAttribute;
8. import org.springframework.web.bind.annotation.RequestMapping;
9. import org.springframework.web.bind.annotation.RequestMethod;
10. import org.springframework.web.bind.annotation.ResponseBody;
11. 
    
12. import com.springmvc.entity.UserEntity;
13. 
    
14. //这一步肯定少不了，前面有介绍就不再介绍了
15. @Controller
16. // 定义访问注册接口的父路径，前面有介绍也不多介绍了
17. @RequestMapping("RegisteredController")
18. public class RegisteredController {
19. 
    
20. // 由于是提交数据所以我们这里使用POST请求
21. @RequestMapping(value = "/registered_post.json", method = RequestMethod.POST)
22. @ResponseBody
23. // 此处@ModelAttribute 可以吧POST请求所携带的json字符串自动解析成后面所写的实体类
24. // ，然后就直接可以通过这个UserEntity取到Android端传过来的数据
25. public Object registered(@ModelAttribute UserEntity entity) {
26. String username = entity.getUsername();
27. String password = entity.getPassword();
28. String nickname = entity.getNickname();
29. String gender = entity.getGender();
30. String age = entity.getAge();
31. // 现在数据已经拿到了（真正开发时候我们需要把这里Android传回来用户登记的数据插入到数据库中就好了）
32. // 为了方便查看,所以这里我把返回的数据拼到一起了
33. String string = "用户名：" + username + " - 密码：" + password + " - 昵称："
34. + nickname + " - 性别：" + gender + " - 年龄：" + age;
35. // 如果数据库插入成功然后返回true，再给Android返回一个消息，告诉Android端已经注册成功，可以进行登录了
36. // 这里没有涉及到数据库操作，所以这里我们这里简单判断一下数据不为null就证明注册成功了
37. if (username != null && password != null && nickname != null
38. && gender != null && age != null) {
39. // 成功返回消息告诉Android端
40. Map<String, String> map = new HashMap<String, String>();
41. map.put("msg", "注册成功！");
42. return map;
43. } else {
44. // 失败返回消息告诉Android端
45. Map<String, String> map = new HashMap<String, String>();
46. map.put("msg", "注册失败！");
47. return map;
48. }
49. }
50. }

那么我们现在给这个接口打个断点，用一个模拟http post请求的工具测试一下这个接口是否写好了

OK进断点了，我们看一下下图，参数全部传了过来，这就说明我们注册成功了！

这样我们SpringMVC的一个小Demo就写完了，那么我在教大家如何把这个项目发不到sae上面，Java项目需要使用war包上传到sae上，所以我们先把我们的程序打包为war包（注意： 注意war包名称必须和appname相同 ）1. 项目右键 选择 Export
2. 选择 JavaEE - WAR file
3. 然后我们选择导出的路径，我就选择桌面了
4. 然后我们进入我们的sae应用中心 - 代码管理 第一次上传需要创建版本
5. 我们选择创建版本
6. 然后我们上传war包 就OK了。

提供几个测试地址：
     ①HelloController ： http://1.springmvcdemo.sinaapp.com/HelloController/hello.json
     ②登录LoginController：http://1.springmvcdemo.sinaapp.com/LoginController/login_get.json/admin/123456
     ③注册RegisteredController：由于这个是POST请求所以就请大家自己测试啦         POST(http://1.springmvcdemo.sinaapp.com/RegisteredController/registered_post.json，需要传入参数)