BES 8.0 Development Guide开发手册完整版.docx

《BES 8.0 Development Guide开发手册完整版.docx》由会员分享，可在线阅读，更多相关《BES 8.0 Development Guide开发手册完整版.docx（142页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、BES 8.0 开发手册BES 8.0 开发手册前言前言本文档是 BES 8.0 的应用开发手册，详细介绍基于 BES 应用服务器的应用开发和部署过程。本手册适合的对象本手册主要适用于使用 BES 开发 Java EE 应用的应用开发人员和应用部署人员。应用开发人员需具备如下技能：1. 面向对象的编程技术；2. Java 语言；3. Java EE API；4. XML；5. BES 管理控制台、iastool 命令行管理工具、BES Eclipse Plugin 的使用；6. 数据库的操作。约定BES 定义了一些变量来表示 BES 目录等信息，本文档中涉及到的有：变量说明BES_HOME文档

2、中借用该值表示 BES 的安装目录，该变量实际上并不存在。ECLIPSE_HOMEEclipse 安装目录。domain-dir域 管 理 服 务 器 实 例 的 目 录 ， 具 体 目 录 为BES_HOMEvardomainsdomain1adminserver。app-name企业应用的名称。module-name单独模块或应用的名称。app-or-module-name应用或模块的名称。产品文档集BES 提供的文档集中包含：1. 安装手册：详细介绍如何在各个操作系统上安装 BES，以及产品的注册过程。2. 用户手册：详细介绍 BES 的配置和管理。3. 开发手册：详细介绍基于 BES

3、应用服务器的应用开发及部署过程。技术支持BES 产品提供全方位的技术支持，获得技术支持的方式有：II网址：Support Email：support Support Tel：400 650 1976在取得技术支持时，请提供如下信息：1. 姓名2. 公司信息及联系方式3. 操作系统及其版本4. BES 版本5. 日志等错误的详细信息BES 8.0 开发手册目录目录VIII第 1 章 搭建开发环境11.1 BES ECLIPSE PLUGIN 简介11.2 配置 BES ECLIPSE PLUGIN11.2.1 安装 BES Eclipse Plugin11.2.2 新建 BES 运行时环境11.

4、2.3 创建应用31.2.4 部署应用61.3 配置 XDOCLET91.3.1 安装 xdoclet-1.2.391.3.2 替换 xdoclet.runtime 文件91.3.3 配置 XDoclet91.3.4 配置 ejbdoclet101.3.5 创建支持 XDoclet 的 EJB 项目111.3.6 创建 SessionBean131.3.7 Bes 私有 Ejb XDoclet tag 映射关系141.3.8 XDoclet 运行方式15第 2 章 WEB 应用172.1 SERVLET172.1.1 Servlet 简介172.1.2 编写 Servlet172.1.2.1

5、初始化 Servlet182.1.2.2 处理请求、返回响应182.1.2.3 请求调度192.1.3 配置 Servlet192.1.4 访问 Servlet202.2 JSP202.2.1 JSP 简介202.2.2 JSP 语法212.2.2.1 标记212.2.2.2 隐式对象212.2.2.3 指令222.2.2.4 声明232.2.2.5 Scriptlet232.2.2.6 表达式232.2.2.7 操作232.2.3 JSP 请求的处理过程242.2.4 预编译 JSP252.2.5 为 Web 应用配置 JSF 和 JSTL252.2.5.1 JavaServer Faces

6、（JSF）252.2.5.2 JavaServer Page 标准标记库（JSTL）252.2.6 自定义标记库（Taglib）252.2.6.1 开发标记处理类262.2.6.2 编写标记库描述符272.2.6.3 使用自定义标记库282.3 监听器282.3.1 Servlet 上下文事件292.3.2 HTTP 会话事件292.3.3 Servlet 请求事件292.3.4 编写监听器302.3.5 配置事件监听器类302.4 过滤器312.4.1 过滤器的工作原理312.4.2 编写过滤器类312.4.3 配置过滤器31第 3 章 EJB 应用333.1 EJB 概述333.2 开发

7、EJB 组件333.2.1 组件接口333.2.2 Home 接口343.2.3 企业 Bean 类353.2.4 部署描述文件353.2.4.1 ejb-jar.xml353.2.4.2 bes-ejb-jar.xml353.3 会话 BEAN363.3.1 什么是会话 Bean？363.3.2 会话 Bean 的类型363.3.2.1 有状态会话 Bean363.3.2.2 无状态会话 Bean393.3.3 会话 Bean 实现393.3.4 会话 Bean 的客户端调用433.3.5 会话 Bean 的限制和优化443.4 实体 BEAN443.4.1 数据的对象视图453.4.2 组

8、件结构453.4.3 Primary Key453.5 消息驱动 BEAN453.5.1 什么是消息驱动 Bean？453.5.2 消息驱动 Bean 实现463.5.3 消息驱动 Bean 池配置483.5.4 MDB 的限制和优化483.6 BES 对 EJB 的支持483.6.1 引用传递493.6.2 池和缓存493.6.2.1 池的参数493.6.2.2 缓存的参数503.6.3 EJB 定时器服务503.7 EJB 的事务513.7.1 底层事务系统抽象513.7.2 声明式、编程式及客户发起的事务513.7.3 EJB 事务属性的取值513.7.4 容器管理事务523.7.5 E

9、JB 3.0 中的事务管理533.7.6 编程式事务53第 4 章 APPCLIENT554.1 APPCLIENT 简介554.2 应用客户端容器简介554.3 使用应用客户端容器开发JAVA EE 应用客户端554.3.1 准备开发环境554.3.2 编写部署描述符564.3.3 编写 AppClient 代码564.3.4 打包应用客户端574.3.5 运行 AppClient574.3.5.1 appclient 命令行工具574.3.5.2 appclient.config 文件57第 5 章 WEB S ERVICES595.1 WEB SERVICES 简介595.2 编写WEB

10、 SERVICES595.2.1 用 Web 容器中运行的 Java 类实现 Web Service605.2.2 用无状态会话 Bean 实现 Web Service615.3 部署WEB SERVICES625.4 浏览WEB SERVICE 的WSDL625.5 测试WEB SERVICE62第 6 章 JPA 应用646.1 JAVA PERSISTENCE API 概述646.2 O/ R 映射基础646.2.1 实体的基本要求646.2.2 实体主键和实体标识666.3 实体关系666.3.1 双向的一对一的关系映射676.3.2 双向的多对一/一对多的关系映射676.3.3 双向

11、的多对多的关系映射686.3.4 单向的多对一的关系696.3.5 单向的一对多的关系706.3.6 单向的多对多的关系706.4 管理实体706.4.1 容器管理的实体管理器716.4.2 应用管理的实体管理器716.4.3 使用 EntityManager 查找实例716.4.4 持久化实体实例726.4.5 清除实体实例726.4.6 同步实体数据到数据库736.4.7 创建查询736.4.8 查询中的命名参数746.4.9 查询中的顺序参数746.5 持久单元74第 7 章 连接器767.1 开发连接器应用767.1.1 开发资源适配器767.1.2 编写 ra.xml777.1.3

12、编写 bes-ra.xml787.2 部署连接器787.2.1 独立连接器787.2.2 嵌入式连接器787.2.3 连接器的重部署78第 8 章 自定义 MBEAN808.1 JMX 简介808.2 开发自定义M BEAN808.2.1 创建管理接口808.2.2 实现管理接口818.2.3 打包自定义 MBean828.3 部署、注册自定义M BEAN828.4 访问自定义M BEAN828.4.1 使用 JConsole 访问自定义 MBean828.4.2 使用管理控制台访问自定义 MBean83第 9 章 安全849.1 应用的安全性849.1.1 应用的安全性分类849.1.1.1

13、 声明安全性849.1.1.2 编程安全性849.1.2 开发安全的 Web 应用849.1.2.1 编写基于 FORM 的登录页面849.1.2.2 编写错误页面859.1.2.3 编写 web.xml869.1.2.4 编写 bes-web.xml879.1.3 为 Web Services 应用配置消息安全性889.1.3.1 为所有方法配置消息保护889.1.3.2 为特定方法配置消息保护899.2 开发自定义审计模块90第 10 章 JDBC9210.1 JDBC 简介9210.2 配置JDBC9210.3 在应用中使用 BES JDBC9210.3.1 创建使用 JDBC 的 Se

14、rvelt9210.3.2 创建使用 JDBC 的过滤器9410.3.3 与 JDBC 相关的部署描述符9410.4 配置数据源和连接池9510.5 部署和管理使用 JDBC 的应用程序95第 11 章 事务9611.1 事务简介9611.2 BES 提供的事务服务9611.2.1 EJB 应用中的事务服务9611.2.1.1 容器管理的事务9611.2.1.2 Bean 管理的事务9711.2.2 RMI 应用中的事务服务9711.3 使用事务服务9711.3.1 使用 JNDI 查找 UserTransaction 对象9711.3.2 启动事务9711.3.3 完成事务97第 12 章

15、JNDI9912.1 JNDI 简介9912.2 使用 CONTEXT 对象查找已命名对象9912.2.1 设置 InitialContext 的 JNDI 环境属性9912.2.2 创建 InitialContext9912.2.3 使用上下文查找已命名对象10012.2.4 关闭上下文10012.3 使用JAVA EE 组件的 JNDI10012.4 外部资源和自定义资源101第 13 章 JMS10213.1 JMS 简介10213.2 配置JMS10213.3 在应用中使用 BES JMS10213.3.1 点对点消息传递例子10213.3.2 发布/订阅消息传递例子10413.3.3

16、 在 MDB 中使用 JMS API 的例子10613.4 配置连接工厂和目的地资源11013.5 部署和管理使用 JMS 的应用程序111第 14 章 JAVAMAIL11214.1 JAVAMAIL 简介11214.2 获取JAVAMAIL 会话11214.3 用 JAVAMAIL 发送邮件11314.4 用 JAVAMAIL 读取邮件114第 15 章 部署应用11515.1 部署单元11515.1.1 Web 模块或应用11515.1.2 EJB 模块或应用11615.1.3 连接器模块或应用11715.1.4 客户端应用11715.1.5 企业应用程序11815.2 部署描述符119

17、15.2.1 bes-web.xml 部署描述符元素12015.2.2 bes-ejb-jar.xml 部署描述符元素12415.2.3 bes-cmp-mapping.xml 部署描述符元素12615.2.4 bes-ra.xml 部署描述符元素12715.2.5 bes-application-client.xml 部署描述符元素12815.2.6 bes-application.xml 部署描述符元素13015.3 部署工具13115.3.1 管理控制台13115.3.2 iastool 命令行工具13115.3.3 BES Eclipse Plugin13215.3.4 自动部署132

18、BES 8.0 开发手册第 1 章 搭建开发环境第1章 搭建开发环境1.1 BES Eclipse Plugin 简介BES 应用服务器提供 Eclipse 插件 BES Eclipse Plugin，该插件便于在 Eclipse 中管理 BES应用服务器实例，开发、调试、部署特定于 BES 的应用。BES Eclipse Plugin 支持 Eclipse Ganymede 3.4 版本，使用该插件之前需先安装 Eclipse Ganymede 3.4。BES Eclipse Plugin 提供的功能有：1. 基于 WTP，是标准插件2. 支持 Java EE 5.0，向后兼容J2EE 1.

19、4 和 J2EE 1.33. 支持在 IDE 中创建、编辑、删除和启停 BES 应用服务器实例4. 支持特定于 BES 的 Web 应用、EJB 应用、企业应用、AppClient 应用的开发、调试和快速部署1.2 配置BES Eclipse PluginBES Eclipse Plugin 基于 WTP，用法与标准的 WTP 插件完全一致。1.2.1 安装 BES Eclipse Plugin1. 获取插件，插件位于 BES_HOMElibpluginseclipseplugin 目录中。2. 将插件程序包 eclipse-plugin.jar 中的 plugins 目录拷贝到 ECLIPS

20、E_HOME 目录下。3. 重启 Eclipse。1.2.2 新建 BES 运行时环境1. 在菜单栏点击“Window”“Preferences”，在“Preferences”页面依次点击“Server”“Runtime Environments”；162. 点击服务器运行时环境列表旁的“Add”按钮，在弹出的页面里选择“BES”“BES v8.0 Java EE 5”；3. 点击下一步，选择 JRE 和 BES 的安装目录；4. 点击完成，“Preferences”页面的服务器运行时环境列表中出现 BES 应用服务器。1.2.3 创建应用BES Eclipse Plugin 支持特定于 BE

21、S 应用服务器的应用开发。创建 Web 应用、EJB 应用、企业应用时，如果指定应用的目标运行时为 BES 应用服务器，BES Eclipse Plugin 就可以生成 BES 特定的部署描述，并支持特定部署描述符的可视化编辑。下面以 Web 应用为例，介绍创建应用时如何使用 BES Eclipse Plugin。1. 新建一个动态 Web 项目，Target Runtime 选择前面创建的“BES v8.0 Java EE 5”， Configuration 选择 BES 的缺省配置；点击上图中 Configuration 的“Modify”按钮可以修改 BES 的缺省配置。BES 的缺省配

22、置默认选择“BES 部署描述符”、“动态 Web 模块”、“Java”三部分，可以更改配置，也可以更改各个部分的版本，如下图所示：2. 按常规步骤完成 Web 应用的创建，创建好的 Web 应用包含 BES 特定的部署描述符bes-web.xml：bes-web.xml 的缺省内容如下：!DOCTYPE bes-web-app PUBLIC -/BES Tech Service(HK) Co., Ltd./DTD BES Application Server 8.0 Servlet 2.5/EN /guessNumberKeep a copy of the generated servlet

23、class java code.也可以切换到文件的 Design 编辑方式编辑 bes-web.xml 文件：1.2.4 部署应用将应用部署到 BES 应用服务器上的步骤为：1. 在应用上选择右键菜单的“Run As”“Run on Server”，新建一个 BES 服务器实例；2. 点击下一步，配置 BES 应用服务器实例的信息：配置项说明Server NameBES 应用服务器实例的名称Domain Name域管理服务器名称Domain Directory域管理服务器所在目录Administrator Id管理员 IDAdministrator Password管理员密码3. 配置完成后，

24、即可在 Server 视图看到新配置的 BES 应用服务器实例，以及已部署的应用，如下图所示：通过右键菜单，还可以启/停 BES 应用服务器实例、从 BES 添加或移除应用等操作：1.3 配置 XDoclet1.3.1 安装 xdoclet-1.2.3将 xdoclet-1.2.3.rar 文件解压到系统的任意位置。1.3.2 替换 xdoclet.runtime 文件将 org.eclipse.jst.j2ee.xdoclet.runtime_1.1.102.v200805140135.jar 文件拷贝到eclipse 的 plugins 目录下，将该目录下原有的 jar 文件替换。1.3.

25、3 配置 XDoclet1) 选择 Window-Preferences，如图所示。2) 点击左侧目录树 XDoclet 节点，右侧页面中点击 Browse 按钮选择 XDoclet1.2.3 在系统中存放目录，如图所示。1.3.4 配置 ejbdoclet点击左侧目录树 XDoclet 节点下的 ejbdoclet 节点，右侧页面中勾选 Bes 选项，点击Apply，如图所示。1.3.5 创建支持 XDoclet 的 EJB 项目1) 创建 EJB 项目，点击 Modify 按钮编辑 EJB 工程支持 XDoclet，如图所示。注意：ejbdoclet 仅支持 3.0 以下版本2) 选中 E

26、JBDoclet 选项，使当前 EJB 工程支持 XDoclet，如图所示。1.3.6 创建 SessionBean1) 使用 Eclipse 提供的 EJB 创建向导创建 SessionBean，如图所示。2) 在新创建的 SessionBean 中添加 Bes 私有 ejb 标签，如图所示。1.3.7 Bes 私有 Ejb XDoclet tag 映射关系Tag 名称属性名称映射说明bes.beanmessage-driven-destination-name针对消息驱动 bean 映射 节点 ， 当此tagName 不存在则默认使用标 准ejb.bean中 的jndi-name值 来 映

27、 射节点connection-factory-name针对消息驱动 bean 映射 节点下节点timeout针对 ejb2.1 版本映射 节点bes.ejb-refref-name映射为节点下节点jndi-name映射为 节点下节点bes.resource-env-refname映射为节点下 节点jndi-name映射为节点下节点bes.resource-refres-name映射为下节点res-ref-name当res-name tag 不存在则映射为映射为下节点jndi-name映射为 下节点1.3.8 XDoclet 运行方式XDoclet 运行方式分为自动运行和手动运行两种方式。1)

28、自动运行，当工程支持 XDoclet，用户添加 XDoclet 标签，在文件保存时，XDoclet 会自动运行。2) 手动运行，当工程支持 XDoclet，用户添加 XDoclet 标签，用户在工程名称上单击鼠标右键，选择 Run XDoclet，如图所示。BES 8.0 开发手册第 2 章 Web 应用第2章 Web 应用2.1 Servlet2.1.1 Servlet 简介Servlet 是 Java EE 标准必不可少的一部分，Servlet 2.5 规范定义了 Servlet API 的实现以及部署 Servlet 的方法。BES 应用服务器完全支持 Servlet 2.5 规范。Se

29、rvlet 是 BES 应用服务器中运行的 Java 类，使用 BES 中运行的 Servlet 可以执行以下操作：1. 创建动态网页，动态网页可以使用 HTML 表单获取终端用户的输入，并为此输入提供响应。2. 创建协作系统，例如在线会议。3. 访问各种 API 和功能，例如：1) 会话跟踪允许网站跨多个网页跟踪用户的进展情况。此功能支持诸如使用购物车的电子商务网站之类的网站。BES 通过在服务器关闭时间和在集群服务器间共享的会话之间提供故障转移，可以支持数据库的会话持久性。2) JDBC 驱动程序JDBC 驱动程序提供了基本的数据库访问。通过 BES 的多层 JDBC 实现，可以利用连接缓

30、冲池、服务器端数据缓存和事务。JDBC 的使用请参看 JDBC。3) EJBServlet 可使用 EJB 封装会话、数据库中的数据及其它功能。EJB 的使用请参看 EJB 应用。4) JMS通过 JMS，Servlet 可以与其它 Servlet 和Java 程序交换消息。JMS 的使用请参看 JMS。5) Java JDK APIServlet 可使用标准的 Java JDK API。6) 转发请求Servlet 可将请求转发到其它 Servlet 或资源。4. 任何符合 Servlet 规范的 Servlet 都可轻松地部署到 BES。HTTP Servlet 是特殊类型的 Servle

31、t，它通常以 HTML 页的形式处理 HTTP 请求并提供HTTP 响应。BES HTTP Servlet 还可以访问数据库、EJB、JMS、HTTP 会话和 BES 的其它工具。2.1.2 编写 ServletServlet API 提供了 javax.servlet.Servlet 接口，所有的 Servlet 必须实现该接口。Servlet API还给出了 HTTP 协议的 Servlet 实现 javax.servlet.http.HTTPServlet，可以通过继承32HTTPServlet 类来编写自己的 Servlet，HTTPServlet 可以读取 HTTP 头、编写 HTM

32、L 编码来将响应传递到浏览器客户端。2.1.2.1 初始化 Servlet. .greetingwelcomenamedeveloper通常，BES 在对 Servlet 发出第一个请求时初始化 Servlet，初始化 Servlet 时，BES 会执行该 Servlet 的 init()方法。在 Web 应用中定义的参数会在初始化期间传递给 Servlet，例如， Web 应用标准部署描述符 web.xml 中的下列条目定义了两个初始化参数：greeting（值为welcome）和 name（值为 developer）：Servlet 的 init()方法会执行 BES 加载 Servlet

33、 时所需执行的一切初始化工作。默认 init() 方法会执行 BES 要求执行的所有初始化工作，可以通过重写 Servlet 的 init()方法来实现所需的初始化功能，比如初始化计数器、创建数据库连接等。如果需要替换 init()，请首先调用super.init()，以便首先执行默认初始化操作。2.1.2.2 处理请求、返回响应Servlet 的主要功能是从 Web 浏览器中接受 HTTP 请求，并返回 HTTP 响应。此项工作由 Servlet 的 service() 方法完成。service()方法包括用于接收来自客户端数据的请求对象HttpServletRequest 和用于创建输出的

34、响应对象 HttpServletResponse。来自 Web 浏览器的 HTTP 请求除了包含 URL 之外，还可以包含表单数据、客户端信息、Cookies、会话和查询参数的相关信息，HTTP Servlet 可通过 HttpServletRequest 对象获得请求中的这些信息。使用向客户端提供响应的 HttpServletResponse 对象，可以设置能转换为 HTTP 头信息的几个 Servlet 特性，例如设置内容类型、字符编码、是否缓存等；也可以获得输出流，然后将响应内容以 HTML 格式写入输出流。2.1.2.3 请求调度Servlet 可以将请求传递给另一个资源，如 Serv

35、let、JSP 或 HTML 页，此过程称为请求调度。调度请求时，请使用 RequestDispatcher 接口的 include()或 forward()方法。通过使用RequestDispatcher，可以避免将 HTTP 重定向响应发送回客户端。RequestDispatcher 会将HTTP 请求传递到请求的资源。要将请求调度到特定资源，请执行下列操作：1. 获取对 ServletContext 的引用：ServletContext sc = getServletConfig().getServletContext();2. 使用下列方法之一查找 RequestDispatcher

36、对象：1) RequestDispatcher rd = sc.getRequestDispatcher(String path);该方法中，path 是相对于 Web 应用的根目录。2) RequestDispatcher rd = sc.getNamedDispatcher(String name);该方式中的 name 是 Web 应用标准部署描述符 web.xml 中使用元素为Servlet 指定的名称。3) RequestDispatcher rd = ServletRequest.getRequestDispatcher(String path);此方法类似于 ServletCon

37、text.getRequestDispatcher(String path)方法，只是它允许相对于当前 Servlet 的 path。如果路径以/字符开头，则会将其解释为相对于 Web 应用。通过在 getRequestDispatcher()方法中请求资源的相应 URL，可以为 Web 应用中的任何HTTP 资源（包括 HTTP Servlet、JSP 页或纯 HTML 页）获取 RequestDispatcher。使用返回的 RequestDispatcher 对象将请求转发到另一个 Servlet。3. 使用适当的方法转发或包含请求。转发、包含请求的用法分别为：1) rd.forward

38、(request,response);2) rd.include(request,response);2.1.3 配置 Servlet编写好 Servlet 后，需要在 web.xml 中为该 Servlet 配置访问 URL。元素定义servlet 的名称、指定执行 servlet 的已编译类，并使用 init-param 元素定义 servlet 的初始化特性。元素定义调用此 servlet 的 URL 模式。举例来说：MailServletsamples.javamail.servlet.SendMailServletgreetingWelcomeMailServlet/mail2.1.

39、4 访问 Servlet访问或引用 Web 应用中的 Servlet 时，URL 按如下所示进行构造：http:/server:port/context-root/requestPath/?requestParameters元素说明server:port为应用提供服务的主机名称及监听端口号。context-root应用的访问根路径。requestPathweb.xml 中为Servlet 配置的 URL 格式。requestParameters可选的 HTTP 请求参数名值对。2.2 JSP2.2.1 JSP 简介JavaServer Pages（JSP）规范用于组合 Java 代码和 HTM

40、L，以提供网页的动态内容。当创建动态内容时，编写 JSP 比编写 HTTP Servlet 更方便，因为JSP 允许将Java 代码直接嵌入到 HTML 页，而对于 HTTP Servlet，则需要将 HTML 嵌入到 Java 代码中。JSP 还可以调用一种称为标记库（taglib）的自定义 Java 类（使用类似于 HTML 的标记）。通过 JSP，可以将网页的动态内容及静态演示内容分开。它可以满足两种不同类型的开发人员：负责网页图形设计的 HTML 开发人员和负责软件开发以创建动态内容的 Java 开发人员。BES 应用服务器支持 JSP 2.1 规范、JSP 标记库和JSTL、还有JSP 预编译。2.2.2 JSP 语法2.2.2.1 标记下表描述可在 JSP 页中使用的基本标记：JSP 标记语法描述Scriptlet嵌入 Java 源代码 Scriptlet。Java 代码会被执行，其输出也会按顺序插入该页的其余 HTML 中。指令指令包含向应用程序服务器发出的消息。指令还可以以名值对的形式向应用服务器提供附加的说明。声明对可由页中