java web开发(二) 接口开发(Java中@)
java web開發(一) 環境搭建講解了如何搭建一個Java Web項目，如果你還沒了解，建議先瀏覽下！今天這篇文章主要講解的就是接口開發，打算使用比較古老的或者說比較原始方法實現的接口。
一.數據庫設計。
假設要做一個簡單的學生信息管理系統，數據庫名為students_manage，并且先設計一張學生表，表名為student。
1.打開Sqlyog工具，如果還沒創建連接，可以點擊新建，輸入名稱，點擊確定即可，
2.然后在保存的連接中選擇，剛剛新建的連接，只需要在密碼輸入框中輸入，安裝數據庫時的設置的密碼，點擊連接，其他的默認即可，
如果都ok的話，那么將會出現如下界面，就代表連接成功了！
3.連接成功后，首先創建數據庫，在左邊的空白區域，鼠標右鍵，創建數據庫，輸入數據庫名稱students_manage，其他的默認，
點擊創建即可，然后在左邊的數據庫列表中會多一個students_manage的數據庫，
4.創建數據庫成功后，我們便可以創建數據庫表，選中students_manage的數據庫中的Tables文件夾，右邊，創建表，輸入表的字段，類型，設置主鍵，是否可為空等，
點擊創建表按鈕，便會看到在Tables文件夾中，多一個student表，
5.雙擊student表，便會打開該表。我們需要給該表中，先初始化一些數據，點擊表數據，然后插入數據，點擊保存。
此時表中已有2條記錄。
數據庫的簡單設計就差不多了，接下來，我們需要開發接口！
PS: 實際開發中，數據庫設計肯定不是這樣的，需要先根據需求分析，做出原型，畫出模型圖（類圖、活動圖等），然后使用專門的數據庫建模工具，完成數據庫與表的設計！
二.接口項目開發。（如果對這一部分有疑問或者不清楚的，歡迎查看java web開發(四) 接口開發補坑1和java web開發(五) 接口開發補坑2！）
接口返回的數據格式是JSON，如果你對JSON還不熟悉，可以先看看文章JSON 使用講解和JSON 解析。
1.新建項目。這個就不多說了！這一塊要是還不了解，請看這篇文章，java web開發(一) 環境搭建。
2.設計接口的Json數據格式。
2.1.接口返回的Json數據格式如下：
(1).返回對象，
{"code":" ","msg":" ","time":1464937933230,"object":{}}(2).返回數組，
{"code":" ","msg":" ","time":1464937933230,"items":[{},{}]}好多讀者都留言，有“code”這個屬性不解。 這兒說明下， Json格式數據中的“code”屬性是響應狀態碼，是標志接口數據的狀態！例如當接口數據返回成功，會設置code為‘ok’。當我們拿到這個“code”時，會根據不同的值，做不同的處理。當“code”等于“ok”時，我們就可以正常解析這個json數據了；返回其他值，我們就只需要作出提示即可。而具體code值是什么，要根據接口自己定義一個規范，當調用者拿到這個code時，就知道如何處理了。有關這個“code”，更加詳細的內容，請看java web開發(五) 接口開發補坑2。
目前就設計返回以上兩種格式。如果你有分頁的話，也可以加上。下面，就展示一下具體實現。
(1).建立AbstractJsonObject(Json數據的基類)，具體實現如下：
public class AbstractJsonObject {
//code
private String code;
//msg
private String msg;
private Long time = new Date().getTime();
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
/**
* @return the time
*/
public Long getTime() {
return time;
}
/**
* @param time
* the time to set
*/
public void setTime(Long time) {
this.time = time;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
public void setContent(String code, String msg) {
this.code = code;
this.msg = msg;
}
public void setStatusObject(StatusObject statusObject) {
this.code = statusObject.getCode();
this.msg = statusObject.getMsg();
}
}
其中，StatusObject是一個狀態對象，封裝了狀態碼(code)和狀態信息(msg)，具體實現如下：
/**
* 狀態對象
*/
public class StatusObject {
// 狀態碼
private String code;
// 狀態信息
private String msg;
public StatusObject(String code, String msg) {
super();
this.code = code;
this.msg = msg;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
}
(2).建立Json對象類SingleObject，代碼：
public class SingleObject extends AbstractJsonObject {
private Object object;
public Object getObject() {
return object;
}
public void setObject(Object object) {
this.object = object;
}
}(3).建立Json數組類ListObject，代碼：
public class ListObject extends AbstractJsonObject {
// 列表對象
private List<?> items;
public List<?> getItems() {
return items;
}
public void setItems(List<?> items) {
this.items = items;
}
}經過上面幾步，我們所需要的json格式數據就創建好了，接下來就是生成json數據了，這兒使用jackjson，JackJson 庫下載。下載完jackson庫后，將三個包導入到項目的lib目中，截圖所示：
(4).JackJsonUtils生成json數據和解析json數據，代碼：
public class JackJsonUtils {
static ObjectMapper objectMapper;
/**
* 解析json
*
* @param content
* @param valueType
* @return
*/
public static <T> T fromJson(String content, Class<T> valueType) {
if (objectMapper == null) {
objectMapper = new ObjectMapper();
}
try {
return objectMapper.readValue(content, valueType);
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
/**
* 生成json
*
* @param object
* @return
*/
public static String toJson(Object object) {
if (objectMapper == null) {
objectMapper = new ObjectMapper();
}
try {
return objectMapper.writeValueAsString(object);
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
}至此，json數據設計就ok了！是不是沒有想象的那么難？也許，就真的這么簡單！接下來，就是接口的開發了。
3.接口開發。
本篇文章開發接口使用的是古老的servlet實現的，關于servlet，請自行查找資料，這里就不多說了(其實我也就一知半解)
3.1.創建一個類繼承自HttpServlet，例如StudentInq，鼠標右鍵，新建->選擇Servlet，截圖所示輸入Servlet名稱，點擊Finish按鈕，就ok了！
此時你會發現包下多了一個StudentInq類，具體代碼:
public class StudentInq extends HttpServlet {
private static final long serialVersionUID = 1L;
/**
* @see HttpServlet#HttpServlet()
*/
public StudentsInq() {
super();
// TODO Auto-generated constructor stub
}
/**
* @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse
* response)
*/
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
// TODO Auto-generated method stub
}
/**
* @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse
* response)
*/
protected void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
// TODO Auto-generated method stub
doGet(request, response);
}
}實現HttpServlet的doGet()和doPost方法，此處為了簡單就只實現doGet()。
PS: 如果你比較細心的話，會發現在web.xml文件中多了幾行代碼，具體如下截圖：(web.xml 是網絡程序中的一個很重要的配置文件，更具體的、詳細的請查詢相關文檔)
，
可以看到我們剛才新建servlet，在這個xml文件中顯示了。后面我們在調用接口的時候便會用到這個配置清單。
3.2. 接口實現。
我們就簡單的實現一個學生查詢接口！調用查詢接口，返回數據庫中所有的學生信息。
(1).新建一個接口StudentService，代碼：
public interface StudentService {
public List<Students> getAllStudents();
}(2). 實現該接口，StudentServiceImpl代碼：
public class StudentServiceImpl implements StudentService{
@Override
public List<Students> getAllStudents() {
// TODO Auto-generated method stub
return StudentBusiness.getAllStudents();
}
}其中，StudentBusiness提供了從數據庫獲取學生信息的方法。有關數據庫操作下面會講到。接著，我們實現Servlet的doGet()，具體代碼：
List<Students> list = new StudentServiceImpl().getAllStudents();
ListObject listObject=new ListObject();
listObject.setItems(list);
listObject.setStatusObject(StatusHouse.COMMON_STATUS_OK);
String responseText = JackJsonUtils.toJson(listObject);
ResponseUtils.renderJson(response, responseText);其中，ResponseUtils是將返回的json數據寫入到response中。
至此，生成json數據已經成功了！但是 貌似少了什么操作？這些數據是從哪里來的？原來數據庫還沒有連接呢！！！好吧！請繼續看下文。
4. 數據庫連接。
文章開頭，我們已經創建好了數據庫以及表，并且也添加了幾條測試數據。數據有了，我們需要在項目中獲取到，那么該怎么操作呢？
(1). 數據庫連接。
我們連接mysql數據庫，需要導入mysql-connector.jar，jar包下載鏈接下載好jar后，導入到lib目錄中，。
(2). 建立DBHelper連接數據庫以及關閉連接：
public class DBHelper {
public static final String url = "jdbc:mysql://localhost:3306/students_manage";
public static final String name = "com.mysql.jdbc.Driver";
public static final String user = "****";
public static final String password = "******";
public Connection conn = null;
public PreparedStatement pst = null;
public DBHelper(String sql) {
try {
Class.forName(name);//
conn = DriverManager.getConnection(url, user, password);//
pst = conn.prepareStatement(sql);//
} catch (Exception e) {
e.printStackTrace();
}
}
public void close() {
try {
this.conn.close();
this.pst.close();
} catch (SQLException e) {
e.printStackTrace();
}
}
}代碼很簡單了，不需要多說！
這一步，我們是連接數據庫，連接成功后，就可以使用表中的數據了！
PS: 實際開發中，有關數據庫操作，肯定不是這么簡單的！比較常用的是框架來管理數據庫相關操作，例如SpringMvc、hibernate和mybats等框架。
三. 運行。
經過上面幾步，我們就大致完成了一個簡單使用Servlet的接口開發，接下來就是見證奇跡的時刻了！
PS: 在運行前，可以在WebContent中添加一個index.jsp，index.jsp代碼：
<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
pageEncoding="ISO-8859-1"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Insert title here</title>
</head>
<body>
<h1>hello world!</h1>
<h2>This is my test page!</h2>
<h3>Welcome to my page!</h3>
</body>
</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開發(三) 接口使用。
最后補上，例子下載地址。由于csdn下載需要積分，所以，我在github上也放置了源碼，下載地址是，接口開發服務端源碼地址！
PS:json格式化工具
推薦文章：SpringMVC 開發接口
博文中經常有小伙伴留言，有關接口項目的問題，最近就推出幾篇補坑的文章，打算這幾篇文章詳解項目中的代碼以及業務流程，java web開發(四) 補坑1和java web開發(五) 接口開發補坑2！歡迎大家查看！
最近才開通了微信公眾號，歡迎大家關注。
總結
以上是生活随笔為你收集整理的java web开发(二) 接口开发(Java中@)的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 微信小程序 弹出框_如何设置小程序弹窗公
- 下一篇： 共阳极数码管