java web開發(fā)(一) 環(huán)境搭建講解了如何搭建一個(gè)Java Web項(xiàng)目，如果你還沒了解，建議先瀏覽下！今天這篇文章主要講解的就是接口開發(fā)，打算使用比較古老的或者說比較原始方法實(shí)現(xiàn)的接口。

一.數(shù)據(jù)庫設(shè)計(jì)。

假設(shè)要做一個(gè)簡單的學(xué)生信息管理系統(tǒng)，數(shù)據(jù)庫名為students_manage，并且先設(shè)計(jì)一張學(xué)生表，表名為student。

1.打開Sqlyong工具，如果還沒創(chuàng)建連接，可以點(diǎn)擊新建，輸入名稱，點(diǎn)擊確定即可，

2.然后在保存的連接中選擇，剛剛新建的連接，只需要在密碼輸入框中輸入，安裝數(shù)據(jù)庫時(shí)的設(shè)置的密碼，點(diǎn)擊連接，其他的默認(rèn)即可，

如果都o(jì)k的話，那么將會(huì)出現(xiàn)如下界面，就代表連接成功了！

3.連接成功后，首先創(chuàng)建數(shù)據(jù)庫，在左邊的空白區(qū)域，鼠標(biāo)右鍵，創(chuàng)建數(shù)據(jù)庫，輸入數(shù)據(jù)庫名稱students_manage，其他的默認(rèn)，

點(diǎn)擊創(chuàng)建即可，然后在左邊的數(shù)據(jù)庫列表中會(huì)多一個(gè)students_manage的數(shù)據(jù)庫，

4.創(chuàng)建數(shù)據(jù)庫成功后，我們便可以創(chuàng)建數(shù)據(jù)庫表，選中students_manage的數(shù)據(jù)庫中的Tables文件夾，右邊，創(chuàng)建表，輸入表的字段，類型，設(shè)置主鍵，是否可為空等，

點(diǎn)擊創(chuàng)建表按鈕，便會(huì)看到在Tables文件夾中，多一個(gè)student表，

5.雙擊student表，便會(huì)打開該表。我們需要給該表中，先初始化一些數(shù)據(jù)，點(diǎn)擊表數(shù)據(jù)，然后插入數(shù)據(jù)，點(diǎn)擊保存。

此時(shí)表中已有2條記錄。

數(shù)據(jù)庫的簡單設(shè)計(jì)就差不多了，接下來，我們需要開發(fā)接口！

PS: 實(shí)際開發(fā)中，數(shù)據(jù)庫設(shè)計(jì)肯定不是這樣的，需要先根據(jù)需求分析，做出原型，畫出模型圖（類圖、活動(dòng)圖等），然后使用專門的數(shù)據(jù)庫建模工具，完成數(shù)據(jù)庫與表的設(shè)計(jì)！

二.接口項(xiàng)目開發(fā)。（如果對這一部分有疑問或者不清楚的，歡迎查看java web開發(fā)(四) 接口開發(fā)補(bǔ)坑1和 java web開發(fā)(五) 接口開發(fā)補(bǔ)坑2！）

接口返回的數(shù)據(jù)格式是JSON，如果你對JSON還不熟悉，可以先看看文章 JSON 使用講解和JSON 解析。

1.新建項(xiàng)目。這個(gè)就不多說了！這一塊要是還不了解，請看這篇文章， java web開發(fā)(一) 環(huán)境搭建。

2.設(shè)計(jì)接口的Json數(shù)據(jù)格式。

2.1.接口返回的Json數(shù)據(jù)格式如下：

(1).返回對象，

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

(2).返回?cái)?shù)組，

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

好多讀者都留言，有“code”這個(gè)屬性不解。 這兒說明下， Json格式數(shù)據(jù)中的“code”屬性是響應(yīng)狀態(tài)碼，是標(biāo)志接口數(shù)據(jù)的狀態(tài)！例如當(dāng)接口數(shù)據(jù)返回成功，會(huì)設(shè)置code為‘ok’。當(dāng)我們拿到這個(gè)“code”時(shí)，會(huì)根據(jù)不同的值，做不同的處理。當(dāng)“code”等于“ok”時(shí)，我們就可以正常解析這個(gè)json數(shù)據(jù)了；返回其他值，我們就只需要作出提示即可。而具體code值是什么，要根據(jù)接口自己定義一個(gè)規(guī)范，當(dāng)調(diào)用者拿到這個(gè)code時(shí)，就知道如何處理了。有關(guān)這個(gè)“code”，更加詳細(xì)的內(nèi)容，請看 java web開發(fā)(五) 接口開發(fā)補(bǔ)坑2。

目前就設(shè)計(jì)返回以上兩種格式。如果你有分頁的話，也可以加上。下面，就展示一下具體實(shí)現(xiàn)。

(1).建立AbstractJsonObject(Json數(shù)據(jù)的基類)，具體實(shí)現(xiàn)如下：

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是一個(gè)狀態(tài)對象，封裝了狀態(tài)碼(code)和狀態(tài)信息(msg)，具體實(shí)現(xiàn)如下：

/**
 * 狀態(tài)對象
 */
public class StatusObject {
	// 狀態(tài)碼
	private String code;

	// 狀態(tài)信息
	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數(shù)組類ListObject，代碼：

public class ListObject extends AbstractJsonObject {

	// 列表對象
	private List<?> items;

	public List<?> getItems() {
		return items;
	}

	public void setItems(List<?> items) {
		this.items = items;
	}

}

經(jīng)過上面幾步，我們所需要的json格式數(shù)據(jù)就創(chuàng)建好了，接下來就是生成json數(shù)據(jù)了，這兒使用jackjson，JackJson 庫下載。下載完jackson庫后，將三個(gè)包導(dǎo)入到項(xiàng)目的lib目中，截圖所示：

(4).JackJsonUtils生成json數(shù)據(jù)和解析json數(shù)據(jù)，代碼：

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數(shù)據(jù)設(shè)計(jì)就ok了！是不是沒有想象的那么難？也許，就真的這么簡單！接下來，就是接口的開發(fā)了。

3.接口開發(fā)。

本篇文章開發(fā)接口使用的是古老的servlet實(shí)現(xiàn)的，關(guān)于servlet，請自行查找資料，這里就不多說了(其實(shí)我也就一知半解)

3.1.創(chuàng)建一個(gè)類繼承自HttpServlet，例如StudentInq，鼠標(biāo)右鍵，新建->選擇Servlet，截圖所示輸入Servlet名稱，點(diǎn)擊Finish按鈕，就ok了！

此時(shí)你會(huì)發(fā)現(xiàn)包下多了一個(gè)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);
	}

}

實(shí)現(xiàn)HttpServlet的doGet()和doPost方法，此處為了簡單就只實(shí)現(xiàn)doGet()。

PS: 如果你比較細(xì)心的話，會(huì)發(fā)現(xiàn)在web.xml文件中多了幾行代碼，具體如下截圖：(web.xml 是網(wǎng)絡(luò)程序中的一個(gè)很重要的配置文件，更具體的、詳細(xì)的請查詢相關(guān)文檔)

，

可以看到我們剛才新建servlet，在這個(gè)xml文件中顯示了。后面我們在調(diào)用接口的時(shí)候便會(huì)用到這個(gè)配置清單。

3.2. 接口實(shí)現(xiàn)。

我們就簡單的實(shí)現(xiàn)一個(gè)學(xué)生查詢接口！調(diào)用查詢接口，返回?cái)?shù)據(jù)庫中所有的學(xué)生信息。

(1).新建一個(gè)接口StudentService，代碼：

public interface StudentService {
	public List<Students> getAllStudents();
}

(2). 實(shí)現(xiàn)該接口，StudentServiceImpl代碼：

public class StudentServiceImpl implements StudentService{

	@Override
	public List<Students> getAllStudents() {
		// TODO Auto-generated method stub
		return StudentBusiness.getAllStudents();
	}

}

其中，StudentBusiness提供了從數(shù)據(jù)庫獲取學(xué)生信息的方法。有關(guān)數(shù)據(jù)庫操作下面會(huì)講到。接著，我們實(shí)現(xiàn)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數(shù)據(jù)寫入到response中。

至此，生成json數(shù)據(jù)已經(jīng)成功了！但是 貌似少了什么操作？這些數(shù)據(jù)是從哪里來的？原來數(shù)據(jù)庫還沒有連接呢！！！好吧！請繼續(xù)看下文。

4. 數(shù)據(jù)庫連接。

文章開頭，我們已經(jīng)創(chuàng)建好了數(shù)據(jù)庫以及表，并且也添加了幾條測試數(shù)據(jù)。數(shù)據(jù)有了，我們需要在項(xiàng)目中獲取到，那么該怎么操作呢？

(1). 數(shù)據(jù)庫連接。

我們連接mysql數(shù)據(jù)庫，需要導(dǎo)入mysql-connector.jar，jar包下載鏈接下載好jar后，導(dǎo)入到lib目錄中，。

(2). 建立DBHelper連接數(shù)據(jù)庫以及關(guān)閉連接：

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();  
	        }  
	    }  

}

代碼很簡單了，不需要多說！

這一步，我們是連接數(shù)據(jù)庫，連接成功后，就可以使用表中的數(shù)據(jù)了！

PS: 實(shí)際開發(fā)中，有關(guān)數(shù)據(jù)庫操作，肯定不是這么簡單的！比較常用的是框架來管理數(shù)據(jù)庫相關(guān)操作，例如SpringMvc、hibernate和mybats等框架。

三. 運(yùn)行。

經(jīng)過上面幾步，我們就大致完成了一個(gè)簡單使用Servlet的接口開發(fā)，接下來就是見證奇跡的時(shí)刻了！

PS: 在運(yùn)行前，可以在WebContent中添加一個(gè)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).在項(xiàng)目上，右鍵->Run As->Run to Server。

如果一切都正常的話，(如果你創(chuàng)建了index.jsp,你會(huì)看到一個(gè)jsp頁面；如果沒有創(chuàng)建index.jsp，可能會(huì)顯示一個(gè)404界面，當(dāng)然沒有創(chuàng)建index.jsp不會(huì)影響咱們接口的調(diào)試)

(2).我們在瀏覽器中輸入‘http://localhost:8080/mServer/StudentInq’，如果一切都正常的話，會(huì)顯示：

或者在瀏覽器中輸入本機(jī)的ip地址，例如’http://192.168.1.133:8080/mServer/StudentInq‘，

看到這個(gè)界面，頓時(shí)淚流滿面！！

四. 總結(jié)。

這么長的篇幅終于實(shí)現(xiàn)了簡單接口的開發(fā)，不容易啊！太感動(dòng)了！我們總結(jié)一下本篇博客實(shí)現(xiàn)開發(fā)接口的步驟：

(1). 數(shù)據(jù)庫表設(shè)計(jì)；

(2). json數(shù)據(jù)設(shè)計(jì)；

(3). 接口實(shí)現(xiàn)。

總結(jié)后，是不是感覺很簡單呢！從此以后，只要看到接口數(shù)據(jù)不如意的，你都可以隨便來改！！(實(shí)際上接口開發(fā)要牽扯好多東西，如果你要了解或者熟悉更多有關(guān)接口開發(fā)，那么就需要結(jié)合Web框架,例如SSH，Springmvc等等，本篇文章只是很基礎(chǔ)的入門開發(fā))至此，通過這篇文章，相信你對接口不再生疏了！下篇文章將介紹，后臺(tái)接口服務(wù)和前端客戶端結(jié)合，詳情請看，java web開發(fā)(三) 接口使用。

最后補(bǔ)上，例子下載地址。由于csdn下載需要積分，所以，我在github上也放置了源碼，下載地址是，接口開發(fā)服務(wù)端源碼地址！

PS: json格式化工具

推薦文章：SpringMVC 開發(fā)接口

博文中經(jīng)常有小伙伴留言，有關(guān)接口項(xiàng)目的問題，最近就推出幾篇補(bǔ)坑的文章，打算這幾篇文章詳解項(xiàng)目中的代碼以及業(yè)務(wù)流程，java web開發(fā)(四) 補(bǔ)坑1和 java web開發(fā)(五) 接口開發(fā)補(bǔ)坑2！歡迎大家查看！

最近才開通了微信公眾號(hào)，歡迎大家關(guān)注。