Использовать XML в JSP

Написание тега

Написание тега теперь должно быть довольно простым. Нам нужно подобрать следующие атрибуты от дизайнера:

• URL к источнику XML
• код для компании (давайте используем CSW, понятное название для моей мифической компании — Clearly Something Wrong Company Ltd)
• имя атрибута, под которым мы хотели бы сохранить результат

Тег не должен иметь никакого содержимого тела, поэтому я реализую TagSupport .

Сразу же, это дает нам:

 package com.clearlysomethingwrong;   import javax.servlet.http.HttpServletRequest;  import javax.servlet.jsp.tagext.TagSupport;  import javax.servlet.jsp.tagext.Tag;  import javax.servlet.jsp.JspException;   import org.xml.sax.SAXException;  import javax.xml.parsers.ParserConfigurationException;  import java.io.IOException;  import java.net.URL;   public class ShowSharePrices extends TagSupport {    public String investorURL;    public String code;    public String friendlyName;    public String attName; 

Сначала мы получаем запрос. Мы собираемся сохранить атрибут здесь, поэтому он нам понадобится. В реальном приложении мы также могли бы проверить, что все значения действительны и были предоставлены значимым образом, чтобы предоставить пользователю (тегу и системе) полезные сообщения об ошибках. Мы создаем объект URL с заданной строкой URL. Этот объект URL просто дает нам доступ к URL, включая предоставление ряда подробностей о нем и открытие для него InputStream.

При условии, что содержимое URL — это то, что нам нужно, это значение затем может быть передано нашему загрузчику информации для инвесторов вместе с кодом, который извлечет соответствующую информацию об акциях и необязательное удобное для пользователя имя для нашей компании.

Если результат не равен NULL, мы устанавливаем атрибут, используя заданное имя атрибута, и завершаем работу:

     public int doStartTag() throws JspException {        HttpServletRequest request = (HttpServletRequest) pageContext.getRequest();        InvestorInformation info = null;         try{           URL url = new URL(investorURL);          info = InvestorInfoLoader.loadInvestorInfo(url.openStream(),                                     code, friendlyName);         } catch(IOException e) {            throw new JspException("Error reading XML source");         } catch (SAXException e) {            throw new JspException("Sax exception occurred: " + e.getMessage());         } catch (ParserConfigurationException e) {            throw new JspException("Configuration error:" + e.getMessage());         }         if(info!=null) {            request.setAttribute(attName, info);        }        return Tag.SKIP_BODY;    } 

За исключением самоочевидных мутаторов и аксессоров, теперь мы можем создать дескриптор библиотеки тегов:

 <?xml version="1.0" encoding="ISO-8859-1" ?>  <!DOCTYPE taglib  PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"  "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">   <taglib>   <tlib-version>1.0</tlib-version>  <jsp-version>1.2</jsp-version>  <short-name>xmlInvestor</short-name>  <uri>/xmlInvestor</uri>  <description>    Investor Information Loader Tag  </description>   <tag>    <name>loader</name>    <tag-class>InvestorInfoLoader</tag-class>    <body-content>empty</body-content>    <description>      Loads investor information given a URL of the XML source, a company investor code, and an attribute name to  store the resultant InvestorInformation class. Optionally, a friendly name can be provided for the company.    </description>     <attribute>      <name>investorURL</name>      <required>true</required>      <rtexprvalue>false</rtexprvalue>    </attribute>     <attribute>      <name>code</name>      <required>true</required>      <rtexprvalue>false</rtexprvalue>    </attribute>     <attribute>      <name>attName</name>      <required>true</required>      <rtexprvalue>false</rtexprvalue>    </attribute>     <attribute>      <name>friendlyName</name>      <required>false</required>      <rtexprvalue>false</rtexprvalue>    </attribute>   </tag>  </taglib> 

При упаковке в соответствии со стандартными требованиями к тегу JSP использовать тег так же просто, как предоставить следующий файл JSP:

 <%@ page import="com.clearlysomethingwrong.InvestorInformation"%>  <%@ taglib uri="/xmlInvestor" prefix="xmlInvestor"%>   <xmlInvestor:loader  friendlyName="Something Clearly Wrong"                code="CSW" attName="InvestInfo"                investorURL="http://localhost:8080/source.xml"/>  <%  InvestorInformation info = (InvestorInformation)request.getAttribute("InvestInfo");  if(info!=null) {    %><%=info.getName()%><br>    <%=info.getCurrentPrice()%><br>      <%=info.getChange()%><br>      <%=info.getTime()%><br>      <%=info.getFormattedDate()%><br>      <%=info.getPercentage()%><br>  <%  }  %> 

Единственной возможной жалобой может быть отсутствие использования другого тега или набора тегов для вывода данных, однако я обнаружил, что теги по-прежнему путают такие программы, как Dreamweaver.

Сценарии в основном предоставляются, потому что Dreamweaver имеет дело с ними более изящно, чем с тегами, о которых он не знает. Для написания плагина требуется значительная поддержка, которая предотвратит разрушение кода обычным дизайнером, когда потребуется редизайн.

Замечание о выводе XML в JSP

По моему мнению, если проект не требует серьезных инвестиций в разработку программного обеспечения, который не является основным для обычного веб-разработчика, написание сложного кода для вывода XML с использованием DOM в приложении на основе JSP неэффективно и вводит дорогостоящие требования к обслуживанию.

В целом, когда достаточно плоская структура — это все, что нужно, интуитивно понятный подход к предоставлению вывода XML заключается в простом копировании формата документа на страницу JSP и вставке скриптлетов, которые будут вставлять необходимые данные.

Документ, который мы только что разработали для предоставления общей информации, будет выглядеть следующим образом:

 <shares>  <share>    <code><%=info.getName()%></code>    <price><%=info.getPrice()%></price>          ... etc  </share>  </shares> 

Во многих случаях это сэкономило много времени, его очень легко проверить (поскольку загрузка его в Internet Explorer также проверит его действительность), и оно отлично справляется со своей задачей.

Запустить этот код

Моя основная среда разработки — J2SDK1.4, в которой обработка XML включена в качестве стандарта. Пользователям JDK1.3 потребуется загрузить пакет XML, доступный по адресу http://java.sun.com/ . В противном случае код включает только стандартные классы Java.

Для облегчения запуска кода я упаковал тег в файл jar в соответствии со спецификациями тега JSP. Это позволяет очень просто включить функциональность, предоставляемую тегом, в файл JSP. Просто поместите jar-файл в каталог lib в WEB-INF . Я рекомендую вам потратить некоторое время на изучение этого простого метода, так как он может сохранить обычный скачок конфигурации в конце проекта и более пригоден для повторного использования.

Вывод

Код довольно прост, но, по возможности, так и должно быть. Каждый класс довольно прост и красиво инкапсулирует свою роль без особого совпадения ролей.

Самая важная вещь — это обработка SAX — используя шаблон, приведенный выше, просто изменить программу, чтобы она соответствовала вашим требованиям. Одно из применений, к которым мы добавили XML, — это надежная связь между ASP и JSP, и, поскольку мы делаем информацию доступной через XML, мы обычно находим ее в другом месте.

Загрузите образцы файлов для этого урока здесь .