java web开发(二) 接口开发

    java web开发(一) 环境搭建讲解了如何搭建基础项目，如果你还没了解，可以先去看看！今天我们就来看看接口的开发，打算使用比较古老的或者说比较原始方法实现的接口。

一.数据库设计。

    我打算做一个简单的学生信息管理系统，数据库名为students_manage，并且先设计一张学生表，表名为student。

1.打开Sqlyong工具，如果还没创建连接，可以点击新建，输入名称，点击确定即可，

2.然后在保存的连接中选择，刚刚新建的连接，只需要在密码输入框中输入，安装数据库时的设置的密码，点击连接，其他的默认即可，

如果都ok的话，那么将会出现如下界面，就代表连接成功了！

3.连接成功后，首先创建数据库，在左边的空白区域，鼠标右键，创建数据库，输入数据库名称students_manage，其他的默认，

点击创建即可，然后在左边的数据库列表中会多一个students_manage的数据库，

4.创建数据库成功后，我们便可以创建数据库表，选中students_manage的数据库中的Tables文件夹，右边，创建表，输入表的字段，类型，设置主键，是否可为空等，

点击创建表按钮，便会看到在Tables文件夹中，多一个student表，

5.双击student表，便会打开该表，我们需要给该表中，先初始化一些数据，点击表数据，然后插入数据，点击保存。

此时表中已有2条记录。

数据库的简单设计就差不多了，接下来，我们需要开发接口！

二.接口项目开发。

    接口返回的数据格式是JSON，如果你对JSON还不熟悉，可以先看看文章 JSON 使用讲解和JSON 解析。

   1.新建项目。这个就不多说了！这一块要是还不了解，请看这篇文章， java web开发(一) 环境搭建。

   2.设计Json数据。

    2.1.接口返回的Json数据格式如下：

   (1).返回对象，

​[java] 

view plain

 copy

 

1. {"code":" ","msg":" ","time":1464937933230,"object":{}}

   (2).返回数组，

​[java] 

view plain

 copy

 

1. {"code":" ","msg":" ","time":1464937933230,"items":[{},{}]}

    目前就设计返回为以上两种格式。如果你有分页的话，也可以加上。下面，就展示一下，代码以及说明。

    (1).建立AbstractJsonObject(Json数据的基类)，具体实现如下：

​[java] 

view plain

 copy

 

1. public class AbstractJsonObject {
2. //code
3. private String code;
4. //msg
5. private String msg;
6. private Long time = new Date().getTime();
7. public String getCode() {
8. return code;
9. }
10. public void setCode(String code) {
11. this.code = code;
12. }
13. /**
14. * @return the time
15. */
16. public Long getTime() {
17. return time;
18. }
19. /**
20. * @param time
21. *            the time to set
22. */
23. public void setTime(Long time) {
24. this.time = time;
25. }
26. public String getMsg() {
27. return msg;
28. }
29. public void setMsg(String msg) {
30. this.msg = msg;
31. }
32. public void setContent(String code, String msg) {
33. this.code = code;
34. this.msg = msg;
35. }
36. public void setStatusObject(StatusObject statusObject) {
37. this.code = statusObject.getCode();
38. this.msg = statusObject.getMsg();
39. }
40. }

    其中，StatusObject是一个状态对象，封装了状态码(code)和状态信息(msg)，具体实现如下：

​[java] 

view plain

 copy

 

1. /**
2. * 状态对象
3. */
4. public class StatusObject {
5. // 状态码
6. private String code;
7. // 状态信息
8. private String msg;
9. public StatusObject(String code, String msg) {
10. super();
11. this.code = code;
12. this.msg = msg;
13. }
14. public String getCode() {
15. return code;
16. }
17. public void setCode(String code) {
18. this.code = code;
19. }
20. public String getMsg() {
21. return msg;
22. }
23. public void setMsg(String msg) {
24. this.msg = msg;
25. }
26. }

    (2).建立Json对象类SingleObject，代码：

​[java] 

view plain

 copy

 

1. public class SingleObject extends AbstractJsonObject {
2. private Object object;
3. public Object getObject() {
4. return object;
5. }
6. public void setObject(Object object) {
7. this.object = object;
8. }
9. }

    (3).建立Json数组类ListObject，代码：

​[java] 

view plain

 copy

 

1. public class ListObject extends AbstractJsonObject {
2. // 列表对象
3. private List<?> items;
4. public List<?> getItems() {
5. return items;
6. }
7. public void setItems(List<?> items) {
8. this.items = items;
9. }
10. }

经过上面几步，我们所需要的json数据格式已经创建好了，接下来就需要解析json数据了，我这儿选择的jackjson， JackJson 库下载。下载完jackson库后，将三个包导入到项目的lib目中，截图所示：

   (4).JackJsonUtils生成json数据和解析json数据，代码：

​[java] 

view plain

 copy

 

1. public class JackJsonUtils {
2. static ObjectMapper objectMapper;
3. /**
4. * 解析json
5. *
6. * @param content
7. * @param valueType
8. * @return
9. */
10. public static <T> T fromJson(String content, Class<T> valueType) {
11. if (objectMapper == null) {
12. objectMapper = new ObjectMapper();
13. }
14. try {
15. return objectMapper.readValue(content, valueType);
16. } catch (Exception e) {
17. e.printStackTrace();
18. }
19. return null;
20. }
21. /**
22. * 生成json
23. *
24. * @param object
25. * @return
26. */
27. public static String toJson(Object object) {
28. if (objectMapper == null) {
29. objectMapper = new ObjectMapper();
30. }
31. try {
32. return objectMapper.writeValueAsString(object);
33. } catch (Exception e) {
34. e.printStackTrace();
35. }
36. return null;
37. }
38. }

    至此，json数据设计就ok了！是不是没有想象的那么难？也许，就真的这么简单！ 接下来，就是接口的开发了。

    3.接口开发。

      本篇文章开发接口使用的是古老的servlet实现的，关于servlet，请自行查找资料，这里就不多说了(其实我也就一知半解)

      3.1.创建一个类继承自HttpServlet，例如StudentInq，鼠标右键，新建->选择Servlet，截图所示输入Servlet名称，点击Finish按钮，就ok了！

此时你会发现包下多了一个StudentInq类，具体代码:

​[java] 

view plain

 copy

 

1. public class StudentInq extends HttpServlet {
2. private static final long serialVersionUID = 1L;
3. /**
4. * @see HttpServlet#HttpServlet()
5. */
6. public StudentsInq() {
7. super();
8. // TODO Auto-generated constructor stub
9. }
10. /**
11. * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse
12. *      response)
13. */
14. protected void doGet(HttpServletRequest request, HttpServletResponse response)
15. throws ServletException, IOException {
16. // TODO Auto-generated method stub
17. }
18. /**
19. * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse
20. *      response)
21. */
22. protected void doPost(HttpServletRequest request, HttpServletResponse response)
23. throws ServletException, IOException {
24. // TODO Auto-generated method stub
25. doGet(request, response);
26. }
27. }

    实现HttpServlet的doGet()和doPost方法，此处为了简单就只实现doGet()。

PS: 如果你比较细心的话，会发现在web.xml文件中多了几行代码，具体如下截图：(web.xml 是网络程序中的一个很重要的配置文件，更具体的、详细的请查询相关文档)

，

可以看到我们刚才新建servlet，在这个xml文件中显示了。后面我们在调用接口的时候便会用到这个配置清单。

    3.2. 接口实现。

    我们就简单的实现一个学生查询接口！调用查询接口，返回数据库中所有的学生信息。

   (1).新建一个接口StudentService，代码：

​[java] 

view plain

 copy

 

1. public interface StudentService {
2. public List<Students> getAllStudents();
3. }

    (2). 实现该接口，StudentServiceImpl代码：

​[java] 

view plain

 copy

 

1. public class StudentServiceImpl implements StudentService{
2. @Override
3. public List<Students> getAllStudents() {
4. // TODO Auto-generated method stub
5. return StudentBusiness.getAllStudents();
6. }
7. }

   其中，StudentBusiness提供了从数据库获取学生信息的方法。有关数据库操作下面会讲到。接着，我们实现Servlet的doGet()，具体代码：

​[java] 

view plain

 copy

 

1. List<Students> list = new StudentServiceImpl().getAllStudents();
2. ListObject listObject=new ListObject();
3. listObject.setItems(list);
4. listObject.setStatusObject(StatusHouse.COMMON_STATUS_OK);
5. String responseText = JackJsonUtils.toJson(listObject);
6. ResponseUtils.renderJson(response, responseText);

   其中，ResponseUtils是将返回的json数据写入到response中。

   至此，接口返回数据已经成功了！目前还没有连接数据库，那么接下来，就是有关数据库的操作。

   4. 数据库操作。

    文章开头，我们已经创建好了数据库以及表，并且也添加了几条测试数据。数据有了，我们需要在项目中获取到，那么该怎么操作呢？

   (1). 数据库连接。

    我们连接MySQL​数据库，需要导入mysql-connector.jar，jar包下载链接​下载好jar后，导入到lib目录中，。

   (2). 建立DBHelper连接数据库以及关闭连接：

​[java] 

view plain

 copy

 

1. public class DBHelper {
2. public static final String url = "jdbc:mysql://localhost:3306/students_manage";
3. public static final String name = "com.mysql.jdbc.Driver";
4. public static final String user = "****";
5. public static final String password = "******";
6. public Connection conn = null;
7. public PreparedStatement pst = null;
8. public DBHelper(String sql) {
9. try {
10. Class.forName(name);//
11. conn = DriverManager.getConnection(url, user, password);//
12. pst = conn.prepareStatement(sql);//
13. } catch (Exception e) {
14. e.printStackTrace();
15. }
16. }
17. public void close() {
18. try {
19. this.conn.close();
20. this.pst.close();
21. } catch (SQLException e) {
22. e.printStackTrace();
23. }
24. }
25. }

这个代码很简单了，不需要多说！

    这一步，我们是连接数据库，连接成功后，就可以使用表中的数据了！

三. 运行。

    经过上面几步，我们就大致完成了一个简单使用Servlet的接口开发，接下来就到了激动人心的时刻了，运行！

PS: 在运行前，可以在WebContent中添加一个index.jsp，index.jsp代码：

​[plain] 

view plain

 copy

 

1. <%@ page language="java" contentType="text/html; charset=ISO-8859-1"
2. pageEncoding="ISO-8859-1"%>
3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
4. <html>
5. <head>
6. <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7. <title>Insert title here</title>
8. </head>
9. <body>
10. <h1>hello world!</h1>
11. <h2>This is my test page!</h2>
12. <h3>Welcome to my page!</h3>
13. </body>
14. </html>

 (1).在项目上，右键->Run As->Run to Server。

如果一切都正常的话，(如果你创建了index.jsp,你会看到一个jsp页面；如果没有创建index.jsp，可能会显示一个404界面；当然没有创建index.jsp不会影响咱们接口的调试)

   (2).我们在浏览器中输入‘http://localhost:8080/mServer/StudentInq’，如果一切都正常的话，会显示：

   或者在浏览器中输入本机的ip地址，例如’http://192.168.1.133:8080/mServer/StudentInq‘，

看到这个界面，顿时泪流满面！！

四. 总结。

    这么长的篇幅终于实现了简单接口的开发，不容易啊！太感动了！我们总结一下实现接口开发步骤：

(1). 数据库表设计；

(2).json数据设计；

(3).接口实现。

  总结后，是不是感觉很简单呢！从此以后，只要看到接口数据不如意的，你都可以随便来改！！(实际上接口开发要牵扯好多东西，如果你要了解或者熟悉更多有关接口开发，那么就需要结合Web框架,例如SSH，Springmvc等等，本篇文章只是很基础的入门开发)至此，通过这篇文章，相信你对接口不再生疏了！下篇文章将介绍，后台接口服务和前端客户端结合，详情请看，​java web开发(三) 接口使用。

  最后补上，例子下载地址。

 PS: json格式化工具

推荐文章：SpringMVC 开发接口

    java web开发(一) 环境搭建讲解了如何搭建基础项目，如果你还没了解，可以先去看看！今天我们就来看看接口的开发，打算使用比较古老的或者说比较原始方法实现的接口。

一.数据库设计。

    我打算做一个简单的学生信息管理系统，数据库名为students_manage，并且先设计一张学生表，表名为student。

1.打开Sqlyong工具，如果还没创建连接，可以点击新建，输入名称，点击确定即可，

2.然后在保存的连接中选择，刚刚新建的连接，只需要在密码输入框中输入，安装数据库时的设置的密码，点击连接，其他的默认即可，

如果都ok的话，那么将会出现如下界面，就代表连接成功了！

3.连接成功后，首先创建数据库，在左边的空白区域，鼠标右键，创建数据库，输入数据库名称students_manage，其他的默认，

点击创建即可，然后在左边的数据库列表中会多一个students_manage的数据库，

4.创建数据库成功后，我们便可以创建数据库表，选中students_manage的数据库中的Tables文件夹，右边，创建表，输入表的字段，类型，设置主键，是否可为空等，

点击创建表按钮，便会看到在Tables文件夹中，多一个student表，

5.双击student表，便会打开该表，我们需要给该表中，先初始化一些数据，点击表数据，然后插入数据，点击保存。

此时表中已有2条记录。

数据库的简单设计就差不多了，接下来，我们需要开发接口！

二.接口项目开发。

    接口返回的数据格式是JSON，如果你对JSON还不熟悉，可以先看看文章 JSON 使用讲解和JSON 解析。

   1.新建项目。这个就不多说了！这一块要是还不了解，请看这篇文章， java web开发(一) 环境搭建。

   2.设计Json数据。

    2.1.接口返回的Json数据格式如下：

   (1).返回对象，

​[java]​  view plain​  ​copy​   ​​ ​

1. {"code":" ","msg":" ","time":1464937933230,"object":{}}

   (2).返回数组，

​[java]​  view plain​  ​copy​   ​​ ​

1. {"code":" ","msg":" ","time":1464937933230,"items":[{},{}]}

    目前就设计返回为以上两种格式。如果你有分页的话，也可以加上。下面，就展示一下，代码以及说明。

    (1).建立AbstractJsonObject(Json数据的基类)，具体实现如下：

​[java]​  view plain​  ​copy​   ​​ ​

1. public class AbstractJsonObject {
2. //code
3. private String code;
4. //msg
5. private String msg;
6. private Long time = new Date().getTime();
7. public String getCode() {
8. return code;
9. }
10. public void setCode(String code) {
11. this.code = code;
12. }
13. /**
14. * @return the time
15. */
16. public Long getTime() {
17. return time;
18. }
19. /**
20. * @param time
21. *            the time to set
22. */
23. public void setTime(Long time) {
24. this.time = time;
25. }
26. public String getMsg() {
27. return msg;
28. }
29. public void setMsg(String msg) {
30. this.msg = msg;
31. }
32. public void setContent(String code, String msg) {
33. this.code = code;
34. this.msg = msg;
35. }
36. public void setStatusObject(StatusObject statusObject) {
37. this.code = statusObject.getCode();
38. this.msg = statusObject.getMsg();
39. }
40. }

    其中，StatusObject是一个状态对象，封装了状态码(code)和状态信息(msg)，具体实现如下：

​[java]​  view plain​  ​copy​   ​​ ​

1. /**
2. * 状态对象
3. */
4. public class StatusObject {
5. // 状态码
6. private String code;
7. // 状态信息
8. private String msg;
9. public StatusObject(String code, String msg) {
10. super();
11. this.code = code;
12. this.msg = msg;
13. }
14. public String getCode() {
15. return code;
16. }
17. public void setCode(String code) {
18. this.code = code;
19. }
20. public String getMsg() {
21. return msg;
22. }
23. public void setMsg(String msg) {
24. this.msg = msg;
25. }
26. }

    (2).建立Json对象类SingleObject，代码：

​[java]​  view plain​  ​copy​   ​​ ​

1. public class SingleObject extends AbstractJsonObject {
2. private Object object;
3. public Object getObject() {
4. return object;
5. }
6. public void setObject(Object object) {
7. this.object = object;
8. }
9. }

    (3).建立Json数组类ListObject，代码：

​[java]​  view plain​  ​copy​   ​​ ​

1. public class ListObject extends AbstractJsonObject {
2. // 列表对象
3. private List<?> items;
4. public List<?> getItems() {
5. return items;
6. }
7. public void setItems(List<?> items) {
8. this.items = items;
9. }
10. }

经过上面几步，我们所需要的json数据格式已经创建好了，接下来就需要解析json数据了，我这儿选择的jackjson，

JackJson 库下载。下载完jackson库后，将三个包导入到项目的lib目中，截图所示：

   (4).JackJsonUtils生成json数据和解析json数据，代码：

​[java]​  view plain​  ​copy​   ​​ ​

1. public class JackJsonUtils {
2. static ObjectMapper objectMapper;
3. /**
4. * 解析json
5. *
6. * @param content
7. * @param valueType
8. * @return
9. */
10. public static <T> T fromJson(String content, Class<T> valueType) {
11. if (objectMapper == null) {
12. objectMapper = new ObjectMapper();
13. }
14. try {
15. return objectMapper.readValue(content, valueType);
16. } catch (Exception e) {
17. e.printStackTrace();
18. }
19. return null;
20. }
21. /**
22. * 生成json
23. *
24. * @param object
25. * @return
26. */
27. public static String toJson(Object object) {
28. if (objectMapper == null) {
29. objectMapper = new ObjectMapper();
30. }
31. try {
32. return objectMapper.writeValueAsString(object);
33. } catch (Exception e) {
34. e.printStackTrace();
35. }
36. return null;
37. }
38. }

    至此，json数据设计就ok了！是不是没有想象的那么难？也许，就真的这么简单！

接下来，就是接口的开发了。

    3.接口开发。

      本篇文章开发接口使用的是古老的servlet实现的，关于servlet，请自行查找资料，这里就不多说了(其实我也就一知半解)

      3.1.创建一个类继承自HttpServlet，例如StudentInq，鼠标右键，新建->选择Servlet，截图所示输入Servlet名称，点击Finish按钮，就ok了！

此时你会发现包下多了一个StudentInq类，具体代码:

​[java]​  view plain​  ​copy​   ​​ ​

1. public class StudentInq extends HttpServlet {
2. private static final long serialVersionUID = 1L;
3. /**
4. * @see HttpServlet#HttpServlet()
5. */
6. public StudentsInq() {
7. super();
8. // TODO Auto-generated constructor stub
9. }
10. /**
11. * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse
12. *      response)
13. */
14. protected void doGet(HttpServletRequest request, HttpServletResponse response)
15. throws ServletException, IOException {
16. // TODO Auto-generated method stub
17. }
18. /**
19. * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse
20. *      response)
21. */
22. protected void doPost(HttpServletRequest request, HttpServletResponse response)
23. throws ServletException, IOException {
24. // TODO Auto-generated method stub
25. doGet(request, response);
26. }
27. }

    实现HttpServlet的doGet()和doPost方法，此处为了简单就只实现doGet()。

PS: 如果你比较细心的话，会发现在web.xml文件中多了几行代码，具体如下截图：(web.xml 是网络程序中的一个很重要的配置文件，更具体的、详细的请查询相关文档)

，

可以看到我们刚才新建servlet，在这个xml文件中显示了。后面我们在调用接口的时候便会用到这个配置清单。

    3.2. 接口实现。

    我们就简单的实现一个学生查询接口！调用查询接口，返回数据库中所有的学生信息。

   (1).新建一个接口StudentService，代码：

​[java]​  view plain​  ​copy​   ​​ ​

1. public interface StudentService {
2. public List<Students> getAllStudents();
3. }

    (2). 实现该接口，StudentServiceImpl代码：

​[java]​  view plain​  ​copy​   ​​ ​

1. public class StudentServiceImpl implements StudentService{
2. @Override
3. public List<Students> getAllStudents() {
4. // TODO Auto-generated method stub
5. return StudentBusiness.getAllStudents();
6. }
7. }

   其中，StudentBusiness提供了从数据库获取学生信息的方法。有关数据库操作下面会讲到。接着，我们实现Servlet的doGet()，具体代码：

​[java]​  view plain​  ​copy​   ​​ ​

1. List<Students> list = new StudentServiceImpl().getAllStudents();
2. ListObject listObject=new ListObject();
3. listObject.setItems(list);
4. listObject.setStatusObject(StatusHouse.COMMON_STATUS_OK);
5. String responseText = JackJsonUtils.toJson(listObject);
6. ResponseUtils.renderJson(response, responseText);

   其中，ResponseUtils是将返回的json数据写入到response中。

   至此，接口返回数据已经成功了！目前还没有连接数据库，那么接下来，就是有关数据库的操作。

   4. 数据库操作。

    文章开头，我们已经创建好了数据库以及表，并且也添加了几条测试数据。数据有了，我们需要在项目中获取到，那么该怎么操作呢？

   (1). 数据库连接。

    我们连接MySQL​数据库，需要导入mysql-connector.jar，jar包下载链接​下载好jar后，导入到lib目录中，。

   (2). 建立DBHelper连接数据库以及关闭连接：

​[java]​  view plain​  ​copy​   ​​ ​

1. public class DBHelper {
2. public static final String url = "jdbc:mysql://localhost:3306/students_manage";
3. public static final String name = "com.mysql.jdbc.Driver";
4. public static final String user = "****";
5. public static final String password = "******";
6. public Connection conn = null;
7. public PreparedStatement pst = null;
8. public DBHelper(String sql) {
9. try {
10. Class.forName(name);//
11. conn = DriverManager.getConnection(url, user, password);//
12. pst = conn.prepareStatement(sql);//
13. } catch (Exception e) {
14. e.printStackTrace();
15. }
16. }
17. public void close() {
18. try {
19. this.conn.close();
20. this.pst.close();
21. } catch (SQLException e) {
22. e.printStackTrace();
23. }
24. }
25. }

这个代码很简单了，不需要多说！

    这一步，我们是连接数据库，连接成功后，就可以使用表中的数据了！

三. 运行。

    经过上面几步，我们就大致完成了一个简单使用Servlet的接口开发，接下来就到了激动人心的时刻了，运行！

PS: 在运行前，可以在WebContent中添加一个index.jsp，index.jsp代码：

​[plain]​  view plain​  ​copy​   ​​ ​

1. <%@ page language="java" contentType="text/html; charset=ISO-8859-1"
2. pageEncoding="ISO-8859-1"%>
3. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
4. <html>
5. <head>
6. <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7. <title>Insert title here</title>
8. </head>
9. <body>
10. <h1>hello world!</h1>
11. <h2>This is my test page!</h2>
12. <h3>Welcome to my page!</h3>
13. </body>
14. </html>

 (1).在项目上，右键->Run As->Run to Server。

如果一切都正常的话，(如果你创建了index.jsp,你会看到一个jsp页面；如果没有创建index.jsp，可能会显示一个404界面；当然没有创建index.jsp不会影响咱们接口的调试)

   (2).我们在浏览器中输入‘http://localhost:8080/mServer/StudentInq’，如果一切都正常的话，会显示：

   或者在浏览器中输入本机的ip地址，例如’http://192.168.1.133:8080/mServer/StudentInq‘，

看到这个界面，顿时泪流满面！！

四. 总结。

    这么长的篇幅终于实现了简单接口的开发，不容易啊！太感动了！我们总结一下实现接口开发步骤：

(1). 数据库表设计；

(2).json数据设计；

(3).接口实现。

  总结后，是不是感觉很简单呢！从此以后，只要看到接口数据不如意的，你都可以随便来改！！(实际上接口开发要牵扯好多东西，如果你要了解或者熟悉更多有关接口开发，那么就需要结合Web框架,例如SSH，Springmvc等等，本篇文章只是很基础的入门开发)至此，通过这篇文章，相信你对接口不再生疏了！下篇文章将介绍，后台接口服务和前端客户端结合，详情请看，​java web开发(三) 接口使用。

  最后补上，例子下载地址。

 PS: json格式化工具

推荐文章：SpringMVC 开发接口