Jboss Seam-gen产生基本项目
Seam的发布包里已包含了命令行工具,用它可以很方便地搭建Eclipse项目,以及生成一些简单的Seam骨架代码,并能从已存在的数据库反向工程到应用程序。
它能让你感受到Seam给开发所带来的快捷,当你在电梯里看到那些令人厌烦的Ruby家伙在吹嘘他们的新玩艺儿是如何优美地在应用中 将繁琐的数据放进数据库时,你就可以取笑他们了。
在此版本中,seam-gen能很好地与JBoss AS一起工作。通过对项目配置进行些许的手工修改,seam-gen生成的项目就可与其它J2EE或Java EE 5应用服务器一起工作。
请注意,并不只限在Eclipse中使用seam-gen。但在本教程中,我们将为你演示如何在Eclipse中用它来完成调试与集成测试。 若你不想安装Eclipse,你仍可跟随教程的步骤,因为所有的操作都是在命令行中完成的。
Seam-gen的Ant脚本与Hibernate工具包放一起,并同时提供了一些模板。这样我们就很容易地根据自己项目的需要来作些修改。
请确保已安装了JDK 5或者JDK6,JBoss AS 4.2和Ant 1.6,以及较新版的Eclipse、JBoss IDE和TestNG的Eclipse 插件。 在Eclipse的JBoss Server View中将JBoss安装路径添加进去。然后以debug模式启动JBoss,并在弹出式命令窗口中进入Seam的目录。
JBoss 很好地支持WAR和EAR的热重部署,但麻烦的是,由于在JVM中存在着多个Bug,在开发进程中多次的重部署EAR是常见的事,但这最终会耗尽 PermGen 空间(Permanent Generation Space)。 因此建议你在开发的过程中加大perm gen空间。若你是在JBoss IDE中运行JBoss,那你就可以在服务器运行配置中的VM arguments进行配置,建议依此修改:
-Xms512m -Xmx1024m -XX:PermSize=256m -XX:MaxPermSize=512
如果你没有那么多的可用内存,你只好用我们推荐的最小内存了:
-Xms256m -Xmx512m -XX:PermSize=128m -XX:MaxPermSize=256
若是在命令行模式中运行JBoss,那你就要在bin/run.conf文件中对JVM选项作修改了。
当然,我们可以先不理会这些。当你在开发中第一次碰到OutOfMemoryException异常时再回过头来作此修改。
首先,我们需要根据现有的开发环境对seam-gen进行配置:JBoss AS安装目录、Eclipse workspace及数据库连接。这些都很容易,只要敲入:
cd jboss-seam-2.0.x
seam setup
根据弹出的提示输入开发环境的相关信息:
C:\Projects\jboss-seam>seam setup
Buildfile: build.xml
setup:
[echo] Welcome to seam-gen :-)
[input] Enter your Java project workspace [C:/Projects]
[input] Enter your JBoss home directory [C:/Program Files/jboss-4.2.0.GA]
[input] Enter the project name [myproject]
helloworld
[input] Is this project deployed as an EAR (with EJB components) or a WAR (with no EJB support) [ear] (ear,war,)
[input] Enter the Java package name for your session beans [com.mydomain.helloworld]
org.jboss.helloworld
[input] Enter the Java package name for your entity beans [org.jboss.helloworld]
[input] Enter the Java package name for your test cases [org.jboss.helloworld.test]
[input] What kind of database are you using? [hsql] (hsql,mysql,oracle,postgres,mssql,db2,sybase,)
mysql
[input] Enter the Hibernate dialect for your database [org.hibernate.dialect.MySQLDialect]
[input] Enter the filesystem path to the JDBC driver jar [lib/hsqldb.jar]
http://www.cnblogs.com/mysql-connector.jar
[input] Enter JDBC driver class for your database [com.mysql.jdbc.Driver]
[input] Enter the JDBC URL for your database [jdbc:mysql:///test]
[input] Enter database username [sa]
gavin
[input] Enter database password []
[input] skipping input as property hibernate.default_schema.new has already been set.
[input] Enter the database catalog name (it is OK to leave this blank) []
[input] Are you working with tables that already exist in the database? [n] (y,n,)
y
[input] Do you want to drop and recreate the database tables and data in import.sql each time you deploy? [n] (y,n,)
n
[propertyfile] Creating new property file: C:\Projects\jboss-seam\seam-gen\build.properties
[echo] Installing JDBC driver jar to JBoss server
[echo] Type 'seam new-project' to create the new project
BUILD SUCCESSFUL
Total time: 1 minute 17 seconds
C:\Projects\jboss-seam>
该工具提供了相应的默认值,因此你可以直接按Enter键。
最重要的是你要对EAR部署还是WAR部署进行选择。EAR项目支持EJB 3.0 并需要Java EE 5。而WAR包不支持EJB 3.0,但可在J2EE环境中部署。 另外WAR也更较简单,便于理解。假若你已安装了EJB3 profile,那你就用ear好了,否则,就只好用war。 在此假设我们选择了EAR部署,当然此教程也适用于WAR部署。
如果你手上有现成的数据模型,请确保你已输入现有数据库的表名。
这些设置保存在seam-gen/build.properties文件中,但你可通过运行seam setup来再次修改。
现在我们就可以在Eclipse workspace目录中创建一个新的项目,只需输入:
seam new-project
C:\Projects\jboss-seam>seam new-project
Buildfile: build.xml
validate-workspace:
validate-project:
copy-lib:
[echo] Copying project jars ...
[copy] Copying 58 files to C:\Projects\helloworld\lib
[copy] Copying 9 files to C:\Projects\helloworld\embedded-ejb
file-copy-war:
file-copy-ear:
[echo] Copying resources needed for EAR deployment to the C:\Projects\helloworld/resources directory...
new-project:
[echo] A new Seam project named 'helloworld' was created in the C:\Projects directory
[echo] Type 'seam explode' and go to http://localhost:8080/helloworld
[echo] Eclipse Users: Add the project into Eclipse using File > New > Project and select General > Project (not Java Project)
[echo] NetBeans Users: Open the project in NetBeans
BUILD SUCCESSFUL
Total time: 7 seconds
C:\Projects\jboss-seam>
这组操作复制了Seam jar文件及相应的jar文件与JDBC驱动jar到新建的Eclipse项目中,并生成了所需的源文件及其配置文件、一个模板文件和样式文件,及相应的Eclipse元数据及Ant构建脚本。 只要你依此操作New -> Project... -> General -> Project -> Next,输入Project name(此例为helloworld),并接着点击Finish,就可将Eclipse项目自动部署到JBoss AS分解式的(exploded)目录结构中,请不要在新项目向导中选择Java Project。
若Eclipse中的默认的JDK不是Java SE 5 或Java SE 6,你就得通过Project -> Properties -> Java Compiler来选择与Java SE 5 兼容的JDK。
另外,可在Eclipse之外输入seam explode来部署项目。
在http://localhost:8080/helloworld中查看此应用的首页。view/home.xhtml是个使用view/layout/template.xhtml模板生成的Facelets 页面,试着在Eclipse中编辑此页面或该模板,并在浏览器中刷新页面,立即看到结果。
别被在项目目录中的如此多的XML配置文件给吓晕了。那都是些标准的Java EE的东西,它们只需生成一次就不用再去理会了。 在所有的Seam项目中,90%的配置内容都是一样的(这些可由seam-gen来帮我们完成)。
新生成的项目包含了三个数据库及持久化配置文件。jboss-beans.xml、persistence-test.xml及import-test.sql文件是用在当TestNG对HSQLDB进行单元测试时。 在import-test.sql中的数据库Schema及其测试数据总是在测试前就已转入数据库中。myproject-dev-ds.xml、persistence-dev.xml及import-dev.sql文件是在部署应用到开发数据库时使用的。 数据库schema是否可在部署时自动导出,取决于你是否在设置seam-gen环境时配置了已存在的数据库。myproject-prod-ds.xml、persistence-prod.xml及import-prod.sql文件是在部署应用到生产数据库时使用的。在部署时数据库schema并不自动导出。
若你熟知传统的action-style. Web框架,你或许想知道在Java中如何来创建无状态action方法的简单Web页面。如果你输入:
seam new-action
则Seam将弹出一些信息并为你的项目生成新的Facelets页面及Seam组件。
C:\Projects\jboss-seam>seam new-action
Buildfile: build.xml
validate-workspace:
validate-project:
action-input:
[input] Enter the Seam component name
ping
[input] Enter the local interface name [Ping]
[input] Enter the bean class name [PingBean]
[input] Enter the action method name [ping]
[input] Enter the page name [ping]
setup-filters:
new-action:
[echo] Creating a new stateless session bean component with an action method
[copy] Copying 1 file to C:\Projects\helloworld\src\action\org\jboss\helloworld
[copy] Copying 1 file to C:\Projects\helloworld\src\action\org\jboss\helloworld
[copy] Copying 1 file to C:\Projects\helloworld\src\action\org\jboss\helloworld\test
[copy] Copying 1 file to C:\Projects\helloworld\src\action\org\jboss\helloworld\test
[copy] Copying 1 file to C:\Projects\helloworld\view
[echo] Type 'seam restart' and go to http://localhost:8080/helloworld/ping.seam
BUILD SUCCESSFUL
Total time: 13 seconds
C:\Projects\jboss-seam>
新增Seam组件后,我们需要重启分解式目录部署(exploded directory deployment)。 输入seam restart,或在Eclipse中已生成项目的build.xml中运行restarttarget就可完成。 另一种方式是在Eclipse中通过编辑resources/META-INF/application.xml文件来强制重启。请注意,在每次修改应用程序时并不需要重启JBoss。
试着在浏览器中输入http://localhost:8080/helloworld/ping.seam地址并点击按钮,看看发生了什么。 在项目的src目录中可看到完成此动作的源代码。 试着在ping()方法中设置个断点,再次点击按钮,又发生了什么?
最后,在测试包中找到PingTest.xml文件,并用Eclipse的TestNG插件来运行测试。 此外,还可用seam test或生成的build文件中的testtarget来运行测试。
下一步就是来创建表单了。请输入:
seam new-form
C:\Projects\jboss-seam>seam new-form.
Buildfile: C:\Projects\jboss-seam\seam-gen\build.xml
validate-workspace:
validate-project:
action-input:
[input] Enter the Seam component name
hello
[input] Enter the local interface name [Hello]
[input] Enter the bean class name [HelloBean]
[input] Enter the action method name [hello]
[input] Enter the page name [hello]
setup-filters:
new-form. [echo] Creating a new stateful session bean component with an action method
[copy] Copying 1 file to C:\Projects\hello\src\com\hello
[copy] Copying 1 file to C:\Projects\hello\src\com\hello
[copy] Copying 1 file to C:\Projects\hello\src\com\hello\test
[copy] Copying 1 file to C:\Projects\hello\view
[copy] Copying 1 file to C:\Projects\hello\src\com\hello\test
[echo] Type 'seam restart' and go to http://localhost:8080/hello/hello.seam
BUILD SUCCESSFUL
Total time: 5 seconds
C:\Projects\jboss-seam>
再次重启应用程序,并在浏览器中输入http://localhost:8080/helloworld/hello.seam就可看到结果了。 接着看下所生成的代码,并运行测试。试着给表单加入一些字段及Seam组件(记着在每次更改Java代码时重新部署)。
在数据库中手工创建一些表。(如果你需要切换不同的数据库,只需再次运行seam setup即可。)现请输入:
seam generate-entities
接着重新部署,并在浏览器中输入http://localhost:8080/helloworld就可看到结果了。 你可以试着浏览数据库,编辑现有的对象,并创建新的对象。如果你看下所生成的代码,你可能会对如此简单的代码感到惊讶。 让开发人员,尤其是那些不甘于受Seam-gen摆布的开发人员,简单地手工编写数据访问代码,是Seam的设计目标之一。
最后,我们想知道能否用标准的Java EE包来部署应用。首先,通过运行seam unexplode来移走分解式目录(exploded directory)。 在命令行中输入seam deploy或运行生成的Build脚本文件中的deploytarget就可完成EAR的部署,用seam undeploy命令或运行undeploy目标可卸下EAR。
默认情况下,应用程序会用dev profile来部署,EAR将包含persistence-dev.xml及import-dev.sql文件,myproject-dev-ds.xml文件也会被部署。 通过输入以下的命令你就可以更改profile, 并可使用prod profile:
seam -Dprofile=prod deploy
你甚至可以给你的应用程序定义新的部署profile,只需在项目中加入合适的文件, 例如:persistence-staging.xml、import-staging.sql及myproject-staging-ds.xml— 并选择使用了-Dprofile=staging名字的profile。
将Seam应用部署成exploded目录的好处是,你能在开发时得到增量热部署的支持。 你只需在components.xml中添加这一行来启用Seam和Facelet中的debug模式即可:
<core:init debug="true"/>
这样一来,重新部署以下文件时就不一定要完全地重启web应用了:
任意Facelet页面
任意pages.xml文件
若想对Java代码进行变更,就需要完全的应用重启。 (在JBoss中,对于EAR部署,这需要用touch命令改变顶层的部署描述文件:对于EAR部署,则是application.xml,而对于WAR部署,则是web.xml。)
但你真正想加快编辑/编译/测试的流程,Seam支持对JavaBean组件进行增量式重部署。 为了用上此功能,你必须把JavaBean组件部署到WEB-INF/dev目录中,以便它们能被特殊的Seam类加载器加载,而不是WAR或EAR类加载器。
请注意以下的限制:
必须是JavaBean组件,而不能是EJB3 Beans(此限制正在解决中)
实体Bean不可热部署
通过components.xml部署的组件可能无法热部署
在WEB-INF/dev之外部署的任何类都无法访问可热部署的组件
须启用Seam的debug模式
如果你用Seam-gen创建WAR项目,增量热部署对于src/action目录下的类是直接可用的,但是对于EAR项目不行。
Seam 2.0是针对JavaServer Faces 1.2开发的,所以我们推荐在JBoss 4.2下使用Seam,因为它包含了JSF 1.2参考实现。 然而仍然有办法在Jboss 4.0下使用Seam。需要两个步骤:安装启用了EJB3的Jboss 4.0版本并且把MyFaces替换为JSF1.2参考实现。 你完成这两个步骤后,Seam2.0就可以在JBoss 4.0下部署了。
JBoss 4.0没有针对Seam的默认配置。想要运行Seam,你必须用JEMS 1.2安装器并且选择EJB3 profile。 如果没有EJB3支持Seam是不能正常运行的。JEMS安装器可以在这里下载:http://labs.jboss.com/jemsinstaller/downloads。