JFinalConfig

概述

    基于JFinal的web项目须要建立一个继承自JFinalConfig类的子类，该类用于对整个web项目进行配置。

    JFinalConfig子类须要实现六个抽象方法，以下所示：

1. public class DemoConfig extends JFinalConfig {
2.     public void configConstant(Constants me) {}
3.     public void configRoute(Routes me) {}
4.     public void configEngine(Engine me) {}
5.     public void configPlugin(Plugins me) {}
6.     public void configInterceptor(Interceptors me) {}
7.     public void configHandler(Handlers me) {}
8. }

2.2 configConstant(..)

    此方法用来配置JFinal常量值，如开发模式常量devMode的配置，以下代码配置了JFinal运行在开发模式：

1. public void configConstant(Constants me) {
2.     me.setDevMode(true);
3. }

    在开发模式下，JFinal会对每次请求输出报告，如输出本次请求的URL、Controller、Method以及请求所携带的参数。

 

2.3 configRoute(..)

一、经常使用配置

    此方法用来配置访问路由，以下代码配置了将 "/hello" 映射到HelloController这个控制器，经过如下的配置，http://localhost/hello  将访问 HelloController.index() 方法，而http://localhost/hello/methodName  将访问到 HelloController.methodName() 方法。

1. public void configRoute(Routes me) {
2.     // 若是要将控制器超类中的 public 方法映射为 action 配置成 true，通常不用配置
3.     me.setMappingSuperClass(false);
4.     
5.     me.setBaseViewPath("/view");
6.     me.addInterceptor(new FrontInterceptor());
7.     me.add("/hello", HelloController.class);
8. }

 

    Routes.setBaseViewPath(baseViewPath) 方法用于为该 Routes 内部的全部 Controller 设置视图渲染时的基础路径，该基础路径与Routes.add(…, viewPath) 方法传入的viewPath以及 Controller.render(view) 方法传入的 view 参数联合组成最终的视图路径，规则以下：

    finalView = baseViewPath + viewPath + view

    注意：当view以 “/” 字符打头时表示绝对路径，baseViewPath 与 viewPath 将被忽略。

 

二、路由配置 API

    Routes 类中添加路由的方法有两个：

1. public Routes add(String controllerKey, Class<? extends Controller> controllerClass, String viewPath)
2. public Routes add(String controllerKey, Class<? extends Controller> controllerClass)

    第一个参数 controllerKey 是指访问某个 Controller 所须要的一个字符串，该字符串惟一对应一个 Controller，controllerKey仅能定位到Controller。

    第二个参数 controllerClass 是该 controllerKey 所对应到的 Controller 。

    第三个参数viewPath是指该Controller返回的视图的相对路径(该参数具体细节将在Controller相关章节中给出)。当viewPath未指定时默认值为controllerKey。

    jfinal 3.6 新增了一个配置方法：setMappingSuperClass(boolean)，默认值为 false。配置成为 true 时，你的 controller 的超类中的 public 方法也将会映射成 action。若是你的项目中使用了 jfinal weixin 项目的 MsgController，则须要将其配置成 true，由于 MsgController 中的 index() 须要被映射成 action 才能正常分发微信服务端的消息。

 

三、极简路由规则

    JFinal 仅有四种路由，路由规则以下表：

    从表中能够看出，JFinal访问一个确切的Action(Action定义见3.2节)须要使用controllerKey与method来精肯定位，当method省略时默认值为index。

    urlPara是为了能在url中携带参数值，urlPara能够在一次请求中同时携带多个值，JFinal默认使用减号“-”来分隔多个值（可经过constants. setUrlParaSeparator(String)设置分隔符），在Controller中能够经过getPara(int index)分别取出这些值。controllerKey、method、urlPara这三部分必须使用正斜杠“/”分隔。

    注意，controllerKey自身也能够包含正斜杠“/”，如“/admin/article”，这样实质上实现了struts2的namespace功能。

    JFinal在以上路由规则以外还提供了ActionKey注解，能够打破原有规则，如下是代码示例：

1. public class UserController extends Controller {
2.     @ActionKey("/login")
3.     public void login() {
4.        render("login.html");
5.     }
6. }

    假定 UserController 的 controllerKey值为“/user”，在使用了@ActionKey(“/login”)注解之后，actionKey由原来的“/user/login”变为了“/login”。该注解还可让actionKey中使用减号或数字等字符，如“/user/123-456”。

    若是JFinal默认路由规则不能知足需求，开发者还能够根据须要使用Handler定制更加个性化的路由，大致思路就是在Handler中改变第一个参数String target的值。

 

四、路由拆分、模块化

    JFinal路由还能够进行拆分配置，这对大规模团队开发十分有用，如下是代码示例：

1. public class FrontRoutes extends Routes {
2.     public void config() {
3.        setBaseViewPath("/view/front");
4.        add("/", IndexController.class);
5.        add("/blog", BlogController.class);
6.     }
7. }

1. public class AdminRoutes extends Routes {
2.     public void config() {
3.        setBaseViewPath("/view/admin");
4.        addInterceptor(new AdminInterceptor());
5.        add("/admin", AdminController.class);
6.        add("/admin/user", UserController.class);
7.     }
8. }

1. public class MyJFinalConfig extends JFinalConfig {
2.     public void configRoute(Routes me) {
3.        me.add(new FrontRoutes());  // 前端路由
4.        me.add(new AdminRoutes());  // 后端路由
5.     }
6.     public void configConstant(Constants me) {}
7.     public void configEngine(Engine me) {}
8.     public void configPlugin(Plugins me) {}
9.     public void configInterceptor(Interceptors me) {}
10.     public void configHandler(Handlers me) {}
11. }

    如上三段代码，FrontRoutes类中配置了系统前端路由，AdminRoutes配置了系统后端路由，MyJFinalConfig.configRoute(…)方法将拆分后的这两个路由合并起来。使用这种拆分配置不只可让MyJFinalConfig文件更简洁，并且有利于大规模团队开发，避免多人同时修改MyJFinalConfig时的版本冲突。

    FrontRoutes与AdminRoutes中分别使用setBaseViewPath(…)设置了各自Controller.render(view)时使用的baseViewPath。

    AdminRoutes 还经过addInterceptor(new AdminInterceptor())添加了 Routes 级别的拦截器，该拦截器将拦截 AdminRoutes 中添加的全部 Controller，至关于业务层的inject拦截器，会在class拦截器以前被调用。这种用法能够避免在后台管理这样的模块中的全部class上使用@Before(AdminInterceptor.class)，减小代码冗余。

 

2.4 configEngine(..)

    此方法用来配置Template Engine，如下是代码示例：

1. public void configEngine(Engine me) {
2.     me.addSharedFunction("/view/common/layout.html");
3.     me.addSharedFunction("/view/common/paginate.html");
4.     me.addSharedFunction("/view/admin/common/layout.html");
5. }

    上面的方法向模板引擎中添加了三个定义了 template function 的模板文件，更详细的介绍详见 Template Engine 那一章节的内容。

   此方法用来配置JFinal的Plugin，以下代码配置了Druid数据库链接池插件与ActiveRecord数据库访问插件。经过如下的配置，能够在应用中使用ActiveRecord很是方便地操做数据库。

1. public void configPlugin(Plugins me) {
2.     DruidPlugin dp = new DruidPlugin(jdbcUrl, userName, password);
3.     me.add(dp);
4.     
5.     ActiveRecordPlugin arp = new ActiveRecordPlugin(dp);
6.     arp.addMapping("user", User.class);
7.     me.add(arp);
8. }

    JFinal插件架构是其主要扩展方式之一，能够方便地建立插件并应用到项目中去。

2.6 configInterceptor(..)

    此方法用来配置JFinal的全局拦截器，全局拦截器将拦截全部 action 请求，除非使用@Clear在Controller中清除，以下代码配置了名为AuthInterceptor的拦截器。

1. public void configInterceptor(Interceptors me) {
2.     me.add(new AuthInterceptor());
3. }

    JFinal 的 Interceptor 很是相似于 Struts2，但使用起来更方便，Interceptor 配置粒度分为 Global、Inject、Class、Method四个层次，其中以上代码配置粒度为全局。Inject、Class与Method级的Interceptor配置将在后续章节中详细介绍。

2.7 configHandler(..)

    此方法用来配置JFinal的Handler，以下代码配置了名为ResourceHandler的处理器，Handler能够接管全部web请求，并对应用拥有彻底的控制权，能够很方便地实现更高层的功能性扩展。

1. public void configHandler(Handlers me) {
2.     me.add(new ResourceHandler());
3. }

   具体用法能够参考 jfinal 源码中给出的几个功能的官方实现：https://gitee.com/jfinal/jfinal/tree/master/src/main/java/com/jfinal/ext/handler

 

注意：Handler 是全局共享的，因此要注意其中声明的属性的线程安全问题

2.8 onStart()、onStop() 回调配置

    在 JFinalConfig 继承类中能够添加 onStart() 与 onStop()，JFinal 会在系统启动完成以后以及系统关闭以前分别回调这两个方法：

1. // 系统启动完成后回调
2. public void onStart() {
3. }
4.  
5. // 系统关闭以前回调
6. public void onStop() {
7. }

     这两个方法能够很方便地在项目启动后与关闭前让开发者有机会进行额外操做，如在系统启动后建立调度线程或在系统关闭前写回缓存。

注意：jfinal 3.6 版本以前这两个方法名为：afterJFinalStart() 与 beforeJFinalStop()。为减小记忆成本、代码输入量以及输入手误的几率，jfinal 3.6 版本改成了目前更简短的方法名。老方法名仍然被保留，仍然可使用，方便老项目升级到 jfinal 最新版本。

2.9 PropKit 读取配置

    PropKit工具类用来读取外部键值对配置文件，PropKit能够极度方便地在系统任意时空使用，配置文件的格式以下：

1. userName=james
2. email=no-reply@jfinal.com
3. devMode=true

 

    以下是 PropKit 代码示例：

1. PropKit.use("config.txt");
2. String userName = PropKit.get("userName");
3. String email = PropKit.get("email");
4.  
5. // Prop 配合用法
6. Prop p = PropKit.use("config.txt");
7. Boolean devMode = p.getBoolean("devMode");

 

    以下是在项目中具体的使用示例：

1. public class AppConfig extends JFinalConfig {
2.   public void configConstant(Constants me) {
3.     // 第一次使用use加载的配置将成为主配置，能够经过PropKit.get(...)直接取值
4.     PropKit.use("a_little_config.txt");
5.     me.setDevMode(PropKit.getBoolean("devMode"));
6.   }
7.  
8.   public void configPlugin(Plugins me) {
9.     // 非第一次使用use加载的配置，须要经过每次使用use来指定配置文件名再来取值
10.     String redisHost = PropKit.use("redis_config.txt").get("host");
11.     int redisPort = PropKit.use("redis_config.txt").getInt("port");
12.     RedisPlugin rp = new RedisPlugin("myRedis", redisHost, redisPort);
13.     me.add(rp);
14.  
15.     // 非第一次使用 use加载的配置，也能够先获得一个Prop对象，再经过该对象来获取值
16.     Prop p = PropKit.use("db_config.txt");
17.     DruidPlugin dp = new DruidPlugin(p.get("jdbcUrl"), p.get("user")…);
18.     me.add(dp);
19.   }
20. }

    如上代码所示，PropKit可同时加载多个配置文件，第一个被加载的配置文件可使用PorpKit.get(…)方法直接操做，非第一个被加载的配置文件则须要使用PropKit.use(…).get(…)来操做。

    PropKit 的使用并不限于在 YourJFinalConfig 中，能够在项目的任何地方使用。此外PropKit.use(…)方法在加载配置文件内容之后会将数据缓存在内存之中，能够经过PropKit.useless(…)将缓存的内容进行清除。