paoding-rose-demo

paoding-rose 环境构建

准备工作

jdk 安装完成
gradle 安装完成
网络ok
构建项目结构工具下载地址

构建项目

生成一枚空的web项目结构如下

| |____src
| | |____main
| | | |____java
| | | | |____org
| | | | | |____demo
| | | | | | |____controllers
| | | | | | |____service
| | | |____resources
| | | |____webapp
| | | | |____WEB-INF
| | |____test
| | | |____java
| | | |____resources

配置build.gradle文件

apply plugin: 'jetty'
apply plugin: 'war'     // web项目的打包格式
apply plugin: 'idea'    // ide的支持，eclipse则填写eclipse

war.archiveName = 'ROOT.war'
group = 'cinao'
version = '1.0.0'
compileJava.options.encoding = 'UTF-8' // 设置默认字符编码为UTF-8

repositories {
  mavenCentral()    // 使用**maven库, 在公司中, 通常会有自己的maven库
}

dependencies {        // 配置项目的jar包依赖
   compile 'commons-dbcp:commons-dbcp:1.4'         // 数据库链接池
   compile 'com.54chen:paoding-rose-scanning:1.0'  // paoding-rose
   compile 'com.54chen:paoding-rose:1.0'
   compile 'com.54chen:paoding-rose-jade:1.1'
   compile 'mysql:mysql-connector-java:5.1.30'
   
   testCompile 'org.springframework:spring-test:2.5.6.SEC02'
   testCompile 'junit:junit:4.11'                  // 单元测试
}

配置web.xml文件

yangcong

<!-- 字符编码 -->
<filter>
    <filter-name>characterEncodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <param-name>forceEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>characterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>


<filter>
    <filter-name>roseFilter</filter-name>
    <filter-class>net.paoding.rose.RoseFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>roseFilter</filter-name>
    <url-pattern>/*</url-pattern>
    <dispatcher>REQUEST</dispatcher>
    <dispatcher>FORWARD</dispatcher>
    <dispatcher>INCLUDE</dispatcher>
</filter-mapping>

```

填写相关demo代码

package org.demo.controllers;

import net.paoding.rose.web.annotation.Path;
import net.paoding.rose.web.annotation.rest.Get;

/**
 * @author hezhiyu on 14/11/6.
 */
@Path("/")
public class DemoController {

    @Get("hi")
    public String sayHi() {
       return "@" + "Hello World!";
    }
}

跑起来

在项目目录下执行gradle war，当现实如下状态时，即打包成功

➜  paoding-rose-base git:(master) gradle war
:compileJava
:processResources
:classes
:war

BUILD SUCCESSFUL

Total time: 6.394 secs

进入项目目录下的build文件夹，在paoding-rose-base/build/libs下会发现一个名为ROOT.war的东东，这货就是我们的web应用的war包

➜  paoding-rose-base git:(master) ls
LICENSE               LICENSE.txt           README.md             build                   
build.gradle          gradle.properties     paoding-rose-base.iml src

复制ROOT.war到web容器中（如tomcat、resin、jetty...），然后启动，我的环境为jetty port:8080，启动容器后状态如下

➜  jetty-8080  tail -f logs/2014_11_06.stderrout.log
十一月 07, 2014 1:19:15 上午 net.paoding.rose.RoseFilter initFilterBean
信息: [init] exits from 'init/mappingTree'
十一月 07, 2014 1:19:15 上午 net.paoding.rose.RoseFilter initFilterBean
信息: [init] exits from 'init'
十一月 07, 2014 1:19:15 上午 net.paoding.rose.RoseFilter printRoseInfos
信息: [init] rose initialized, 2 modules loaded, cost 692ms!    (version=1.0.1-20100805)
2014-11-07 01:19:15.632:INFO:ROOT:main: [init] rose initialized, 2 modules loaded, cost 692ms! (version=1.0.1-20100805)
2014-11-07 01:19:15.660:INFO:oejsh.ContextHandler:main: Started o.e.j.w.WebAppContext@9d84476{/,file:/private/var/folders/lb/qlsp55px2yvb4mkwx3zxg42r0000gn/T/jetty-0.0.0.0-8080-ROOT.war-_-any-1291130023571217795.dir/webapp/,AVAILABLE}{/ROOT.war}
2014-11-07 01:19:15.705:INFO:oejs.ServerConnector:main: Started ServerConnector@4fc5dce6{HTTP/1.1}{0.0.0.0:8080}
2014-11-07 01:19:15.706:INFO:oejs.Server:main: Started @4384ms

用浏览器或curl访问一记: http://192.168.1.10:8080/hi

➜  jetty-8080  curl http://192.168.1.10:8080/hi
Hello World!%

注意事项

Paoding 功能Demo

Interceptor

参考文档
- paoding google code wiki

paoding-rose中的Interceptor，我倾向于使用全局与特定作为区分，并在Demo中，Interceptor位于org.demo.interceptorpackage下对于Interceptor解析如下问题

Interceptor的配置
多个Interceptor的执行顺序（待续）

Interceptor的配置

xx.java extends ControllerInterceptorAdapter
重写相关方法
- 对于全局Interceptor重写 before(Invocation inv, Object instruction):Object 与 after(Invocation inv, Object instruction):Object
- 对于特定Interceptor重写 getRequiredAnnotationClass():、before(Invocation inv, Object instruction):Object、after(Invocation inv, Object instruction):Object
配置applicationContext

    <!-- 配置Interceptor -->
    <bean class="org.demo.interceptor.GlobalInterceptor"/>
    <bean class="org.demo.interceptor.LoginInterceptor"/>

集成quartz job

在build.gradle中配置jar包依赖compile 'org.quartz-scheduler:quartz:1.8.5'
在配置bean对象, e.g org.demo.quartz.QuartzJob
在applicationContext中进行相关配置, e.g src/main/resources/applicationContext.xml
打WAR包,扔到web容器中, 结果如下

信息: [init] rose initialized, 2 modules loaded, cost 889ms! (version=1.0.1-20100805)
2015-04-07 14:40:37.103:INFO:ROOT:main: [init] rose initialized, 2 modules loaded, cost 889ms! (version=1.0.1-20100805)
2015-04-07 14:40:37.128:INFO:oejsh.ContextHandler:main: Started o.e.j.w.WebAppContext@7b7f9803{/,file:/private/var/folders/lb/qlsp55px2yvb4mkwx3zxg42r0000gn/T/jetty-0.0.0.0-8080-ROOT.war-_-any-1826129721453283633.dir/webapp/,AVAILABLE}{/ROOT.war}
2015-04-07 14:40:37.154:INFO:oejs.ServerConnector:main: Started ServerConnector@7b543c23{HTTP/1.1}{0.0.0.0:8080}
2015-04-07 14:40:37.155:INFO:oejs.Server:main: Started @4681ms
I'm a quartz job work~~ time: Tue Apr 07 14:41:00 CST 2015
I'm a quartz job work~~ time: Tue Apr 07 14:42:00 CST 2015
I'm a quartz job work~~ time: Tue Apr 07 14:43:00 CST 2015
I'm a quartz job work~~ time: Tue Apr 07 14:44:00 CST 2015

以Main方法启动Paoding

paoding是一套web-framework, 在main方法启动的场景下会有:

测试Service
如果是Service 仅需要一枚标准的Spring applicationContext.xml即可
测试DAO
如果是DAO, 则需要引入applicationContext.xml与applicationContext-jade.xml

PS: 一个重点，要保证所有的配置文件与编译后的classes在同一个文件夹下

代码片段如下，完整的参考项目中的PaodingStart.java


    public static void main(String[] args) {
        String[] applicationContextArr = new String[] {"applicationContext.xml", "applicationContext-jade.xml"};

        ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext(applicationContextArr);

        UserService userService = (UserService)ctx.getBean("userService");

        String username = userService.getUserNameById(1001278L);
        System.out.println(username);

    }

发布paoding可识别的Jar包

根据官方wiki的解释，paoding的Root Context由:

WEB-INF/applicationContext*.xml、classes/applicationContext*.xml、xxx.jar/applicationContext*.xml组成的ApplicationContext。

所以，引申出的关键问题为：如何配置一个Rose可识别的Jar包?

方法为:

为了使jar文件根目录下的applicationContext*.xml能够被rose“认识到”，你需要在xxx.jar/META-INF下创建一个rose.properties文件，并写入一个属性rose=applicationContext 。如果没有这个属性，即使你的xxx.jar包根目录含有applicationContext*.xml文件，也不会被rose识别。

对于gradle与maven工程可以采用如下的项目结构:

在resource文件夹下创建META-INF目录
将rose.properties放置在改目录下

验证方式:

通过命令gradle build进行打包，而后解压即可在classpath或Jar包的META-INF中看到rose.properties文件.

zhiyu-he/paoding-rose-demo