java寫介面,java寫介面調用

本文目錄一覽：

• 1、java介面文檔怎麼寫
• 2、java介面怎麼寫
• 3、Java中的介面怎麼實現?
• 4、java如何寫一個介面？

java介面文檔怎麼寫

一些剛開始寫介面文檔的服務端同學，很容易按著代碼的思路去編寫介面文檔，這讓客戶端同學或者是服務對接方技術人員經常吐槽，看不懂介面文檔。這篇文章提供一個常規介面文檔的編寫方法，給大家參考。

推薦使用的是docway 寫介面文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。

一、請求參數

1. 請求方法

GET

用於獲取數據

POST

用於更新數據，可與PUT互換，語義上PUT支持冪等

PUT

用於新增數據，可與POST互換，語義上PUT支持冪等

DELETE

用於刪除數據

其他

其他的請求方法在一般的介面中很少使用。如：PATCH HEAD OPTIONS

2. URL

url表示了介面的請求路徑。路徑中可以包含參數，稱為地址參數，如**/user/{id}**，其中id作為一個參數。

3. HTTP Header

HTTP Header用於此次請求的基礎信息，在介面文檔中以K-V方式展示，其中Content-Type則是一個非常必要的header，它描述的請求體的數據類型。

常用的content-type：

application/x-www-form-urlencoded

請求參數使用「」符號連接。

application/json

內容為json格式

application/xml

內容為xml格式

multipart/form-data

內容為多個數據組成，有分隔符隔開

4. HTTP Body

描述http body，依賴於body中具體的數據類型。如果body中的數據是對象類型。則需要描述對象中欄位的名稱、類型、長度、不能為空、默認值、說明。以表格的方式來表達最好。

示例：

二、響應參數

1. 響應 HTTP Body

響應body同請求body一樣，需要描述請清除數據的類型。

另外，如果服務會根據不同的http status code 返回不同的數據結構， 也需要針對不同的http status code對內容進行描述。

三、介面說明

說明介面的應用場景，特別的注意點，比如，介面是否冪等、處理是同步方式還是非同步方式等。

四、示例

上個示例（重點都用紅筆圈出來，記牢了）：

五、介面工具

推薦使用的是（以前叫小幺雞） 寫介面文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。

java介面怎麼寫

public interface A{

public void a(int x);

}

public class MyA implements A{

public void a(int x) {

System.out.println(x);

}

}

//介面是一個抽象類型，是抽象方法的集合，介面通常以interface來聲明；

如有幫助請採納(不懂請提問)，可以看我主頁，歡迎來交流學習；

Java中的介面怎麼實現?

舉個面積的例子：在java中，定義一個介面，聲明計算長方形面積和周長的抽象方法，再用一個類去實現這個介面，再編寫一個測試類去使用這個介面。首先，介面必須單獨存放，如果我們用eclipse編程的話，它們提示：The public type **** must be defined in its own file，意思是必須要定義在其自己的文件中，所以要為介面文件單獨存放起來，舉例，我們的介面要實現獲到矩形的長，寬，面積，周長，所以定義以下的介面。public interface calrect {\x0d\x0apublic abstract int calarea();\x0d\x0apublic abstract int calgirth();\x0d\x0apublic abstract int getx();\x0d\x0apublic abstract int gety();\x0d\x0a}注意，定義介面就像定義類一樣，介面的訪問控制符只能用public，用public定義的介面可以被所有的類和包引用，而預設的則只能被同一個包中的其他類和介面引用，這符合JAVA中訪問控制符的一般要求，關於介面再引用其他介面則是後話。以上介面文件名為calrect.java.另外需要指出的是介面中不能給方法給出方法體。接下來，需要定義一個類來實現介面，因為不知道JAVA的內置矩形類是什麼名，所以為了安全，將該類定義為RRect，這可以認為是一種安全策略。關於implements，可以參考其他資料。該類引用了介面calrect，所以必須對calrect中的方法一一實現。//定義矩形類 應用介面class RRect implements calrect{private int x;\x0d\x0aprivate int y;public RRect (){\x0d\x0a x=3;y=4;\x0d\x0a}\x0d\x0apublic int calarea(){\x0d\x0a return x*y;\x0d\x0a}\x0d\x0apublic int calgirth(){\x0d\x0a return x*2+y*2;\x0d\x0a}\x0d\x0apublic int getx(){\x0d\x0a return x;\x0d\x0a}\x0d\x0apublic int gety(){\x0d\x0a return y;\x0d\x0a}\x0d\x0a}//接下來，定義一個測試類，所謂測試類，我理解為定義一個類，在其定義類RRect的對象，並驗證其中的方法，看看是不是可以正常使用//定義Class1類\x0d\x0apublic class Class1{\x0d\x0aRRect rect;\x0d\x0apublic static void main(String []args){\x0d\x0a RRect rect=new RRect();\x0d\x0a System.out.println(“矩陣的長”+ rect.getx());\x0d\x0a System.out.println(“矩陣的寬”+ rect.calarea());\x0d\x0a System.out.println(“矩陣的面積”+ rect.calarea());\x0d\x0a System.out.println(“矩形的周長 “+rect.calgirth());\x0d\x0a}\x0d\x0a\x0d\x0a}運行結果：矩陣的長3\x0d\x0a矩陣的寬12\x0d\x0a矩陣的面積12\x0d\x0a矩形的周長 14註：介面單存放，介面實現類和測試類可以存放在一個文件中

java如何寫一個介面？

非常簡單，基礎語法：

public interface 介面名 {

常量定義;

抽象方法定義；

default 方法定義；

}

即使你在介面中不定義任何方法，也是可以的。