（JavaEE-10）自定義標籤庫

#自定義標籤庫開發

###自定義標籤簡介

• 自定義標籤主要用於移除Jsp頁面中的java代碼
• 使用自定義標籤移除jsp頁面中的java代碼，只須要完成如下兩個步驟
  • 編寫一個實現Tag接口的Java類(標籤處理器類)
  • 編寫標籤庫描述符（tld）文件，在tld文件中把標籤處理器類描述成一個標籤
  • demo：查看JSP中的API，使用標籤獲取客戶機IP（3步：編寫一個Java類，繼承TagSupport，重寫父類方法，實現業務代碼；編寫一個tld文件描述該Java類，借鑑Tomcat中的例子；在頁面導入該標籤庫，通常的，標籤前綴與tld文件名稱一致）

###自定義標籤的執行流程

• JSP引擎將遇到自定義標籤時，首先建立標籤處理器類的實例對象，而後按照JSP規範定義的通訊規則依次調用它的方法
  1. public void setPageContext(PageContext pc)， JSP引擎實例化標籤處理器後，將調用setPageContext方法將JSP頁面的pageContext對象傳遞給標籤處理器，標籤處理器之後能夠經過這個pageContext對象與JSP頁面進行通訊
  2. public void setParent(Tag t)，setPageContext方法執行完後，WEB容器接着調用的setParent方法將當前標籤的父標籤傳遞給當前標籤處理器，若是當前標籤沒有父標籤，則傳遞給setParent方法的參數值爲null
  3. public int doStartTag()，調用了setPageContext方法和setParent方法以後，WEB容器執行到自定義標籤的開始標記時，就會調用標籤處理器的doStartTag方法
  4. public int doEndTag()，WEB容器執行完自定義標籤的標籤體後，就會接着去執行自定義標籤的結束標記，此時，WEB容器會去調用標籤處理器的doEndTag方法
  5. public void release()，一般WEB容器執行完自定義標籤後，標籤處理器會駐留在內存中，爲其它請求服務器，直至中止web應用時，web容器纔會調用release方法

###自定義標籤功能擴展

• 開發人員在編寫Jsp頁面時，常常還須要在頁面中引入一些邏輯，例如：
  • 控制jsp頁面某一部份內容是否執行
  • 控制整個jsp頁面是否執行
  • 控制jsp頁面內容重複執行
  • 修改jsp頁面內容輸出
• 自定義標籤除了能夠移除jsp頁面java代碼外，它也能夠實現以上功能
  • Tag接口
  • IterationTag接口
  • BodyTag接口
  • 注意各個接口中方法的執行時機
• tld文件中的四種標籤體類型
  • EMPTY JSP scriptless（不能使用腳本元素，包括JSP腳本、JSP聲明、JSP表達式） tagdepentend（標籤體的內容是給標籤用的，不作輸出打印）

###簡單標籤庫開發

因爲傳統標籤使用三個標籤接口來完成不一樣的功能，顯得過於繁瑣，不利於標籤技術的推廣， SUN公司爲下降標籤技術的學習難度，在JSP 2.0中定義了一個更爲簡單、便於編寫和調用的SimpleTag接口來實現標籤的功能。實現SimpleTag接口的標籤一般稱爲簡單標籤。簡單標籤共定義了5個方法：

• setJspContext方法
  • 用於把JSP頁面的pageContext對象傳遞給標籤處理器對象
• setParent方法
  • 用於把父標籤處理器對象傳遞給當前標籤處理器對象
• getParent方法
  • 用於得到當前標籤的父標籤處理器對象
• setJspBody方法
  • 用於把表明標籤體的JspFragment對象傳遞給標籤處理器對象
• doTag方法
  • 用於完成全部的標籤邏輯，包括輸出、迭代、修改標籤體內容等。在doTag方法中能夠拋出javax.servlet.jsp.SkipPageException異常，用於通知WEB容器再也不執行JSP頁面中位於結束標記後面的內容，這等效於在傳統標籤的doEndTag方法中返回Tag.SKIP_PAGE常量的狀況

###SimpleTag接口方法的執行順序

• 當web容器開始執行標籤時，會調用以下方法完成標籤的初始化：
  • WEB容器調用標籤處理器對象的setJspContext方法，將表明JSP頁面的pageContext對象傳遞給標籤處理器對象
  • WEB容器調用標籤處理器對象的setParent方法，將父標籤處理器對象傳遞給這個標籤處理器對象。注意，只有在標籤存在父標籤的狀況下，WEB容器纔會調用這個方法
  • 若是調用標籤時設置了屬性，容器將調用每一個屬性對應的setter方法把屬性值傳遞給標籤處理器對象。若是標籤的屬性值是EL表達式或腳本表達式，則WEB容器首先計算表達式的值，而後把值傳遞給標籤處理器對象
    • 若是簡單標籤有標籤體，容器將調用setJspBody方法把表明標籤體的JspFragment對象傳遞進來
• 執行標籤時：
  • 容器調用標籤處理器的doTag()方法，開發人員在方法體內經過操做JspFragment對象，就能夠實現是否執行、迭代、修改標籤體的目的

###JspFragment類

• javax.servlet.jsp.tagext.JspFragment類是在JSP2.0中定義的，它的實例對象表明JSP頁面中的一段符合JSP語法規範的JSP片斷，這段JSP片斷中不能包含JSP腳本元素
• WEB容器在處理簡單標籤的標籤體時，會把標籤體內容用一個JspFragment對象表示，並調用標籤處理器對象的setJspBody方法把JspFragment對象傳遞給標籤處理器對象。JspFragment類中只定義了兩個方法，以下所示：
  • getJspContext方法
    • 用於返回表明調用頁面的JspContext對象
  • public abstract void invoke(java.io.Writer out)
    • 用於執行JspFragment對象所表明的JSP代碼片斷
    • 參數out用於指定將JspFragment對象的執行結果寫入到哪一個輸出流對象中，若是傳遞給參數out的值爲null，則將執行結果寫入到JspContext.getOut()方法返回的輸出流對象中。(簡而言之，能夠理解爲寫給瀏覽器)

###invoke方法詳解

• JspFragment.invoke方法是JspFragment最重要的方法，利用這個方法能夠控制是否執行和輸出標籤體的內容、是否迭代執行標籤體的內容或對標籤體的執行結果進行修改後再輸出。例如：
  • 在標籤處理器中若是沒有調用JspFragment.invoke方法，其結果就至關於忽略標籤體內容
  • 在標籤處理器中重複調用JspFragment.invoke方法，則標籤體內容將會被重複執行
  • 若想在標籤處理器中修改標籤體內容，只需在調用invoke方法時指定一個可取出結果數據的輸出流對象（例如StringWriter），讓標籤體的執行結果輸出到該輸出流對象中，而後從該輸出流對象中取出數據進行修改後再輸出到目標設備，便可達到修改標籤體的目的

標記處理器對象不會被重用，傳統標記處理器會駐留在內存中以供後續使用

###開發帶屬性的標籤

自定義標籤能夠定義一個或多個屬性，這樣，在JSP頁面中應用自定義標籤時就能夠設置這些屬性的值，經過這些屬性爲標籤處理器傳遞參數信息，從而提升標籤的靈活性和複用性。

• 要想讓一個自定義標籤具備屬性，一般須要完成兩個任務
  • 在標籤處理器中編寫每一個屬性對應的setter方法
  • 在TLD文件中描術標籤的屬性
• 爲自定義標籤訂義屬性時，每一個屬性都必須按照JavaBean的屬性命名方式，在標籤處理器中定義屬性名對應的setter方法，用來接收JSP頁面調用自定義標籤時傳遞進來的屬性值。 例如屬性url，在標籤處理器類中就要定義相應的setUrl(String url)方法
• 在標籤處理器中定義相應的set方法後，JSP引擎在解析執行開始標籤前，會調用set屬性方法，爲標籤設置屬性
• 屬性值只支持8中數據類型，若是是別的類型，就須要直接使用別的類型來傳遞值（如：Date類型，那麼在頁面能夠經過 new Date()來傳值）

案例：

• 開發防盜鏈標籤
• 開發<c:if>標籤
• 開發<c:if><c:else>標籤
• 開發迭代標籤
• 開發html轉義標籤
• demo地址
• 打包標籤庫，新建一個普通的Java工程，將須要打包的類直接拷貝過去；建立META-INF文件夾，將tld文件拷貝進去。而後「導出」選擇「jar」，完成。
• Jar包打成exe文件