valueList的用法.docVIP

兔八哥翻译的ValueList帮助 版本:0.3 ValueList的OverView概述在很多情况下，使用JDBC是很繁琐的，有很多方法可以替换JDBC，比如JDO、Hibernate等。即使在从service中接收POJO的List的解决方案中，我们仍然鼓励使用ValueListHandler来统一访问所有的service。在这种情况下，你应该实现自己的ValueListAdapter，它的作用是调用你的业务方法，同时也要把查询结果转换为一个ValueList。配置perties文件是ValueListHandler服务标签库的配置文件,它包含了定制外观和定制属性的一些配置。但是，这个文件现在已经不再推荐使用了。对于在Web下怎么使用Spring，请看/docs/reference/beans.html。 下面这个文件是例子中的配置文件： 上面配置文件中的bean“valueListHandler”是一个服务，这个服务有用于valueListHandler的adapter的map，使用Spring关联adapter，可以使这些adapter以统一的方式配置。下图是一个真实项目的配置文件：怎么使用service？上文简述了怎么向valueListHandler中添加adapter和query，从例子中的配置片断中你可以看到有一个叫做nbaTeams的adapter，它是从team表中select数据的查询。通过这个查询，我们将逐步解决查询返回的数据。得到service的实例ValueListHandler是一个接口，所以你要实现它。在Web环境中，最简单的获取ValueListHandler的方法是使用Spring来获取。准备调用service在服务被调用之前，必须创建ValueListInfo，它包含下面的内容：Filter构造查询的Map排序列用于排序的列（一个或者多个）排序方向用于排序的方向（一个或者多个列）页号当前页号，如果为空的话，则service会设置它总记录数调用后，被server设置行数/页每页上显示的记录的行数条件的属性用于指定条件查询的属性名，相当于列名条件的值指定条件的值，相当于指定的列的值创建info对象，按照“team”列排序从服务中请求ValueList这个方法将返回一个ValueList，它包含一个List和传给service的info。ValueList也是一个Iterator，下面是接收它的方法：1 第一个参数是adapter的名字，上面的代码中的adapter的名字是“nbateams”，这个adapter在上面的xml文件中已经配置好了。2 adapter用于从数据库中接收数据。作为“ValueListHandler”配置中的adapter，它必须实现ValueListAdapter接口。3 现在service已经有数据了。service还有一个机会去更改ValueList：如果service想对数据进行排序、分页、过滤，它可以使用adapter的方法getAdapterType。这样如果需要，adpater就可以代理分页、排序、过滤等功能。4 service返回ValueList。显示ValueList：在Web环境下，有一些标签用于显示ValueList，它们将在以后讨论。显示ValueList也有一个Jtable的实现。当然我们并不限制你用哪种方式。标签的例子：代码说明：行号名称描述Since1vlh:root这个标签是必须的，他是所有vlh元素的顶级元素。0.1.32vlh:retrieve它调用ValueListHandler，并请求ValueList，然后把ValueList传给vlh:root标签。注意：如果你不使用MVC的push模式的话，应该使用该标签。(push:是指数据是由数据是由框架推向显示页面的，显示页面并不能主动取得数据，相对于“拉”)0.1.15vlh:row这是一个iterate标签，它对ValueList进行循环显示。0.1.0611vlh:column它指定显示哪个属性（字段）。0.1.0更多的细节和示例，请参见valuelist.war。内置的adapterDefaultDynaBeanAdapter返回DynaBean的一个ValueList。对于简单的程序或者例子来说，它是很有用的。但我们不推荐你在真正的程序里面使用它。DefaultDynclassAdapter返回Dynclass的一个ValueList。对于简单的程序或者例子来说，它是很有用的。但我们不推荐你在真正的程序里面使用它。DefaultWrapperAdapter返回封装了ResultSet的ValueList，我推荐在在下列情况下使用：Hibernate的HQL太复杂，不能控制所有的复合连接。FileSystemAdapter返回FileInfo的ValueList，在Web上浏览一个文件系统时，它是很有用的。Hibernate20Adapter返回POJO的ValueList。它也能返回指定条件的一条记录。除了FileSystemAdapter，其他的adapter都可以调用行的校验。你可以在Hibernate20Adapter找到简单的用法。在MVC框架中怎么使用ValueList这部分的主要目的是要解决“刷新按钮问题”（就是点击“刷新”按钮引起的问题）。在Web程序中，你可能常常redirect到一个“view”上,并且要保证不能丢失分页、排序、查询条件的信息（focus：在原文中多次出现“focus”，按照上下文的理解应该是按照指定条件进行查询的意思）。请考虑下面的情况：你要删除一条数据，如果你是通过向请求字符串中添加一个转向参数（注：这个请求类似于：http:/localhost:8080/jbxx.do?method=delete&id=123456）来实现的话，可能在删除数据后，转向到一个显示结果的jsp。但是如果用户点击“刷新”按钮，则还会提交同样的请求。（注：我在使用AppFuse的过程中也遇到这样的问题，DisplayTag没有处理这种情况，所以会执行同样的动作，但是数据已经在前一步被删除了，所以数据库会报错，我使用Struts的saveToken的方法来解决了这个问题，但我发现AppFuse的原来的用户部分就不会报这个错误，后来发现它转向的视图还是当前页面，所以没有这个问题。）。所以，我们需要实现一个service helper类来解决这个问题。得到service的helper的实例ValueListHandlerHelper是在设置任何ValueListHandler实现前必须创建的一个类，在Web环境下，最简单的办法是使用Spring的bean Factory来创建它。下一步是告诉你的Controller你要使用哪个service的helper类的实例。“刷新”按钮问题的解决方案现在，我们来关注更多的细节，设想一下：在jsp中，我们有一个id=MyTable.的表，Struts的Controller的代码可能如下：首先，我们必须得到ValueList的实际的info，我们可以修改它，然后，把它备份到Session中。如果请求中没有任何id=”MyTable”的Table的信息，它会试着从上一个保存的备份（ValueListInfo）中获取。因此，在执行每个Action后，必须备份ValueList的info。更多的信息，请参见： javadoc for the ValueListHadlerHelper 或者看 source the code of this strutss controller 或者看例子 valuelist.war 的下面的部分： 经过MVC的ValueListHandlerHelper备份ValueListInfo到session中。例子如果你想找一个好的、使用ValueList的例子的话，请参见Fantasy Sports Components的配置文件。这个文件里面有一个叫做“playerRank”的查询，这个查询有left join, inline view和大量的group by，它使用的是DefaultDynaBeanAdapter。2005-03-04 13:36Hibernate20Adapter的文档原文：/adapters/Hibernate20Adapter.html属性名称必需默认值描述adapterTypeN01.JVM中排序2.JVM中分页4.在JVM中过滤(还没有实现)sessionFactoryYN/AHibernate SessionFactory的实例hsql废弃建议使用hql代替hqlY必需有一个2个中的一个Spring配置文件中定义的查询namedQueryN定义在你的Hibernate的映射文件中查询的名字。如果你想使用排序和条件查询的话，我们推荐你不要使用这个属性。defaultNumberPerPageNInteger.MAX_VALUE每页显示的记录数，可以被ValueListInfo中的值覆盖。defaultSortColumnNN/A结果集排序的列，可以被ValueListInfo中的值覆盖。defaultSortDirectionNN/A可以被ValueListInfo中的值覆盖。allowCreateNtrue如果在绑定的线程中没有发现，允许创建一个新的SessionmaxRowsForFocusNLong.MAX_VALUE进行focus查询的结果集的最大行数defaultFocusPropertyObjectAliasN从Hibernate的SQL语法中得到focus属性的对象的名字：SELECT defaultFocusPropertyObjectAlias.focusProperty FROM XXXremoveEmptyStringsNfalse是否使用给定的filter 的值的长度检测，如果filter的值是null或者“”，将从查询中被删除。validatorNnull对已经查询出来的记录进行后期处理的ValidatorfocusOptimalizationNtrue在focus查询的时候，是否使用statement的优化功能statementBuilderN所有属性的字符串setter的隐式对象(Implicit object)支持Long, Timestamps和其他的hibernate类型设置Hibernate查询的preparedStatement 。它用于filter的conjuction使用HQL属性的图：使用NamedQuery的属性的图：配置文件的例子：需要注意的是：在标签中的HQL不是一个有效的hql。/sortColumn: ORDER BY sortColumn sortDirection/ 包含 “/”、“”、“”和“”。 下面让我为你解释这些无效的字符都是起什么作用的。Filter你可以使用某些条件限制的ValueList的记录。我们要感谢叫做“Filter”的东西，Hibernate20Adapter使用ValueListInfo.filters的值去动态构造查询。应用规则如下： /sortColumn: / 被称做filter。 只有ValueListInfo.filters 包含sortColumn时，/ 和/之间的内容才会被包含。 sortColumn 被称作constant。 和 之间的内容将被ValueListInfo.filters map的值替换。 例如: ORDER BY sortColumn DESC = ORDER BY my_sorted_column DESC name 被称作 bind varable。 和 之间的内容被? 替换，然后ValueListInfo.filters map中的值将被设置到PreparedStatement。例如: WHERE = name = WHERE = :name 注意： 默认情况下，Hibernate20Adapter将你的bind varable作为PreparedStatement的一个字符串。(通常像这样：Query.setString(name,(String) valueListInfo.getFilters().get(name);) 当然，Hibernate20Adapter也可以设定其他类型，如Timestamps，但你需要用你的key和key的类型的名字声明map。这种map的管理者叫做StatementBuilder。 bind varable： name 将被设置为String。 myLongId 将被设置为Long。 (你可以这样设想:Query.setLong(myLongId,(Long) valueListInfo.getFilters().get(myLongId);) 注意： StatemntBuilder与在基于adapter的jdbc中的用法类似。See war example adapters config file. Focusing如果你想使用focus特性，你可以直接设置focusValue, focusProperty，它们告诉Hibernate20Adapter你将focus什么。当你点击下一页按钮时，Focus将会被自动关闭，所以，你必须使它可以使用（Enable）。例如：例子中的第一列不能被排序，你可以设定sortable=desc，这样就可以排序了。下一个非常有用的标签是：focusStatus，它会告诉你当进行focus搜索时正在发生什么。如果能用Focus，这个标签将会创建一个Table。如果你设置focusproperty为一个非null的值时，focus将可以使用。更多的细节请看：focus status tag。Validator我们经常会遇到这样的情况，我们使用Hibernate接收数据是非常复杂的。此时，你应该使用ObjectValidators。Validator帮你使用JVM级别的过滤，并且仍然支持分页和Hibernate20Adapter的其他功能。使用Validator之前，你需要做如下的工作：1 实现你的ObjectValidator接口2 创建Bean：PlayersObjectValidator，并将Hibernate20Adapter的validator属性设置为PlayersObjectValidator。 这个解决方案在如下情况下是适用的：如果在数据库层不能filter，则可以使用这种方法。因为它是在JVM级别进行操作的，所以效率很差。 你也应该为focus关闭查询的optimalization。如果你设定focusOptimalization 为false，则会实现这个目的。 正常情况下，在被focus的对象所在的页上，focus选择只针对focusproperty的属性 (比如，一个普通的数字 - id) ，并且不是针对整个对象的快速探测。这样你只需要控制focus属性，你可以打开optimalization。 更多的信息请参见示例的war文件 (version 0-1-7Beta9或者更高的版本)。 2005-03-04 15:58ValueList的Tutorial我只翻译了主要步骤1 配置数据源我们为WEB-INF/classes/applicationContext.xml文件添加MySQL数据源，添加后，文件内容如下：2 配置ValueListAdapter原始的WEB-INF/classes/applicationContext.xml文件中有2个adapter entry，类型都是net.mlw.vlh.adapter.file.FileSystemAdapter，删除它们，再添加一个新的。我们的查询依赖于数据库，所以我们使用DynaBeanAdapter（你也可以写自己的adapter）。我们希望每页显示20条记录，并且按照points_avg排序。3 创建一个JSP在目录WEB-INF/jsp/reports下创建一个新的叫做playerRank.jsp的jsp。我们首先把report1.jsp中的内容复制进来：行号描述12导入这页中用到的标签。8这个report的title。12Vlh：root标签是所有其他vlh标签都需要的父标签。13vhl:retrieve标签调用ValueListHandler服务，然后接收一个ValueList。注意 name=playerRank属性，它必须和上文讨论的applicationContext.xml文件中的一个 adapter entry相匹配。 15vhl:row标签将对ValueList进行循环，并创建table。 1618vhl:column 标签在table中添加一列。添加完所有需要定义的列之后，我们的jsp内容如下：4 为我们的新report添加一个链接打开文件：jsp/layout/Header.jsp.删除2个例子的链接，添加一个新链接。你也可以用自己公司的Logo和名字覆盖掉默认的Logo和名字。注意：URL中的参数report的值是jsp的名字，没有扩展名”.jsp”。使用的是Spring的MVC框架。2005-03-04 16:31在Struts或其他框架中使用ValueList：在Struts或其他框架中使用ValueList原文链接：/blogs/kris/archives/2004/09/how_to_setupval.htmlValueList是一个需要Spring支持的工具，它和DisplayTag和DataGrid的很大的不同是-它使用Spring处理从数据库中获取的数据，在Display和DataGrid中，你从一个collection中接受数据，然后在collection上处理分页，但是，如果你的collection中超过5000条记录呢？而ValueList查询的只是你需在当前页显示的数据，所以，即使数据量再大，对它来说也不是问题。Valuelist使用以一种清晰的解耦办法将数据层和表示层进行分离。因为valuelist文档很少，所以，我愿意把用我的痛苦总结出来的经验分享给你，因为它真的很好！在下面的例子中，我使用它提供的jdbcAdaptor，当然你可以使用其他的像Hibernate的适配器，或者你自己写的适配器。共有如下几个文件：applicationContext.xmlview.jspCustomAdaptorStruts Action第一步 配置文件你需要有一个Spring的applicationContext.xml文件，并且添加valuelist的entry。 false 8 startdate asc select el.JOB_KEY as jobKey, el.START_DATE_TIME as startdate, el.END_DATE_TIME as enddate, job.job_name as jobname, jobstatus.job_execution_status_descr as status From JOB_EXECUTION_LOG el, JOB job, JOB_EXECUTION_STATUS jobstatus where el.job_key = job.job_key and jobstatus.job_execution_status_code = el.job_execution_status_code /jobId: and el.job_key = jobId/ /sortColumn: ORDER BY sortColumn sortDirection/ 关键问题是怎么得到输入的参数：/jobId: and el.job_key = jobId/sortColumn: ORDER BY sortColumn sortDirection/也就是说在request中有一个叫做jobId的参数，它很可能是从form的一个post动作中提交过来的。还有2个参数SortColumn和sortDirection，不需要你手工的放入request中，当用户点击视图中的需要排序的列时，valuelist会自动为你修改这些参数的。需要注意的是，在上面的配置的前面有一个默认的排序列和排序方向。你可以在列的标题附近看到一个用于排序的箭头，它们用来链接排序的列。你可以查看例子的截屏。第二步 创建定制的适配器public class JobHistoryAdapter extends AbstractJdbcAdapter public List processResultSet(String name, ResultSet result, int numberPerPage) throws SQLException List list = new ArrayList(); for ( int rowIndex = 0; result.next() & rowIndex numberPerPage; rowIndex+) JobHistoryDisplayBean historyBean = new JobHistoryDisplayBean(); historyBean.jobLog.setJobInstanceKey(result.getString(jobKey); historyBean.jobLog.setStartDateTime(result.getDate(startdate); historyBean.jobLog.setEndDateTime(result.getDate(enddate); historyBean.job.setJobName(result.getString(jobname); historyBean.status.setJobExecutionStatusDescr(result.getString(status); list.add(historyBean