Spring Surf入门

  • A+
所属分类:二次开发

1、什么是Spring Surf?

Spring Surf是Spring的一个扩展工程。 它允许你用script脚本的方式提供web服务,同时在脚本里能够调用spring bean

Spring Surf包括了以下几个方面

  • Surf
  • Web Scripts
  • Web Editor
  • Spring Roo Add-on
  • SpringSource Tool Suite Plugin
  • Sample Sites
  • PHP and Groovy scripting for Spring Web Applications

实际上必须的就是1和2,即Surf和webscripts。 其他几项都是为了辅助开发方面的应用

2、Spring Surf 来源

它来源于一个文档和内容管理系统Alfresco。 Alfresco在向外提供内容服务时,发现仅提供REST层面的服务实现的功能很有限, 换而言之仅通过Web调用在处理事务、同步、性能等方面问题很多, 为此,Alfresco提供了一个脚本环境,允许用户定义自己的逻辑脚本跑在服务器端。 脚本就可以直接在服务器端调用封装好的bean服务, 而整个逻辑过程通常是事务性的。

另一个方面,随着运用的深入,在share基础上进行二次开发对于一般用户来说显得十分困难。因此Alfresco提出了以Spring Surf为基础构建应用,再调用Alfresco服务的解决方案。可以说Spring Surf是目前Alfresco二次开发的最佳解决方案。

从代码来看, Spring Surf 的核心部分的代码都是由Alfresco提交的。

3、Hello Spring Surf

首先 来到 http://www.springsurf.org/ 即其官方网站

下载Spring Surf Empty Web Application或Spring Surf Quick Start Web Application

最好是后者, 还有几个例子

把war扔在tomcat下,启动

找到WEB-INF\webscripts目录

创建一个test目录

创建3个文件放在这个目录下

(1) Web服务描述文件 test.get.desc.xm

<webscript>
<shortname>Company Header</shortname>
<description>Company Header</description>
<url>/test/gs</url>
</webscript>

(2) 请求处理脚本 test.get.js

model.headerTitle = "Hello WebScripts";

(3) 页面模板文件 test.get.html.ftl

<div class="left">
    <table width="100%">
        <tr>
            <td nowrap><img src="${url.context}/res/images/SurfLogo200.jpg" alt="Spring Surf入门" alt="Surf" height="75px" /></td>
            <td style="padding-top: 10px; font-size: 28px; font-family: Helvetica; color: #AAAAAA;" nowrap>  ${headerTitle}</td>
            <td width="100%"></td>
        </tr>
    </table>
</div>

重新启动tomcat 再访问http://127.0.0.1:8080/spring-surf-application-quickstart-1.0.0.M3/test/gs

怎么样,3个文件完成一个服务,是不是感觉也很一般?

4、三个文件的分工

因为有了工具,可能开发这些东西会稍微轻松一些。但这里还要把3个文件的用途说一下

*.desc.xml文件描述了这个服务, 在上面例子中,只是指定了服务的url。 这个参数也是唯一必须的配置项。

还有一些别的配置,比如一个比较全的配置会写成这样

<webscript kind="org.alfresco.httpsonly">
    <shortname>Hello World</shortname>
    <description>Greet a user</description>
    <url>/sample/helloworld?to={name}</url>
    <url>/sample/helloworld.xml?to={name}</url>
    <format default="html">extension</format>
    <lifecycle>sample</lifecycle>
    <authentication runas="fred">user</authentication>
    <transaction>required</transaction>
    <family>Sample</family>
    <cache>
        <never>false</never>
        <public>false</public>
        <mustrevalidate/>
    </cache>
    <negotiate accept="text/html">html</negotiate>
    <negotiate accept="text/xml">xml</negotiate>
</webscript>

指定多个url,指定运行的用户或指定必须登录, 指定需要事务,指定处理缓存等

*.js 指定了页面的处理逻辑。 在样例应用中,只有页面对象和http相关对象可供调用。 用户可以把自己的服务封装成js对象在这个文件里调用。

.ftl是一个freemaker模板文件。它和.js文件共享一些对象。

5、Spring Surf的意义

看了以上的介绍,可能有人会问, 构建一个web服务的确会比较有趣,但能给我们带来更多的东西呢?

其实大家有没有发现,这个web服务不涉及到任何Java代码, 换而言之,当服务增、改、删除时, 整个服务器是不需要重启的,并且应该也不会有Classloader的创建或者类重新加载。 并且服务的描述、开发和重部署都有了一个明确的规则 这就很方便第3方应用提供者基于一个平台构建服务。

而且Spring Surf同时集成了Remote调用Alfresco服务的方式,同时Spring Surf Webscripts 和Alfresco JavaScript Webscripts是几乎一样的构造逻辑,也就是在后台直接编写js方法调用java bean对象。这种前后端几乎一样的编写方式,大大降低了二开成本。

发表评论

您必须才能发表评论!