前言

　　逃离北上广从广州回老家南宁，入职这家公司用的技术是JFinal，借此机会得以学习这个国产的MVC框架，经过一段时间的学习，基于之前的经验搭建一个通用项目jfinal-demo

　　jfinal-demo是基于JFinal封装的一个简单通用项目，一套通用代码，实现增删改查分页等基础功能，单表模块通过继承通用模块实现该基础功能，通过代码生成器可快速生成全套单表代码。

　　技术栈：JFinal + MySql

　　JFinal介绍

　　JFinal已连续多次获得GVP Gitee最有价值开源项目，gitee地址：

　　JFinal官方文档：

　　JFinal官方简介：

　　JFinal 是基于 Java 语言的极速 WEB + ORM + AOP + Template Engine 框架，其核心设计目标是开发迅速、代码量少、学习简单、功能强大、轻量级、易扩展、Restful。在拥有Java语言所有优势的同时再拥有ruby、python、php等动态语言的开发效率！为您节约更多时间，去陪恋人、家人和朋友 :)

　　JFinal有如下主要特点：

　　MVC架构，设计精巧，使用简单

　　遵循COC原则，支持零配置，无xml

　　独创Db + Record模式，灵活便利

　　ActiveRecord支持，使数据库开发极致快速

　　自动加载修改后的java文件，开发过程中无需重启web server

　　AOP支持，拦截器配置灵活，功能强大

　　Plugin体系结构，扩展性强

　　多视图支持，支持FreeMarker、JSP、Velocity

　　强大的Validator后端校验功能

　　功能齐全，拥有struts2的绝大部分功能

　　体积小仅 723 KB，且无第三方依赖

　　代码编写

　　项目结构

　　jfinal.bat、jfinal.sh是启动脚本

　　通用代码包括统一返回对象Result，分页条件PageCondition，控制层CommonController，业务层CommonService/Impl

　　数据库表与实体类的关系映射需要在_MappingKit中手动进行维护（其实也可以做成自动维护，只是我们的代码生成器还不支持）

/** * 数据表、主键、实体类关系映射 * 需要手动维护 */public class _MappingKit {    /**     * 表、实体、主键关系集合     * 方便SqlUtil工具类拼接查询sql     */    public static HashMap<String,String> tableMapping = new HashMap<>();    public static HashMap<String,String> primaryKeyMapping = new HashMap<>();    public static void mapping(ActiveRecordPlugin arp) {        arp.addMapping("blog", "id", Blog.class);        tableMapping.put(Blog.class.getName(),"blog");        primaryKeyMapping.put(Blog.class.getName(),"id");        arp.addMapping("user", "user_id", User.class);        tableMapping.put(User.class.getName(),"user");        primaryKeyMapping.put(User.class.getName(),"user_id");    }}

　　表字段全部在BaseModel中（禁止改动）

/** * 博客表 BaseModel * * 作者：Auto Generator By 'huanzi-qch' * 生成日期：2021-07-26 09:31:41 */@SuppressWarnings("serial")public abstract class BaseBlog<M extends BaseBlog<M>> extends Model<M> implements IBean {    //博客id    private Integer id;    public void setId(Integer id) {        this.id = id;        set("id", this.id);    }    public Integer getId() {        this.id = get("id");        return this.id;    }    //博客标题    private String title;    public void setTitle(String title) {        this.title = title;        set("title", this.title);    }    public String getTitle() {        this.title = get("title");        return this.title;    }    //博客内容    private String content;    public void setContent(String content) {        this.content = content;        set("content", this.content);    }    public String getContent() {        this.content = get("content");        return this.content;    }    //用户id    private String userId;    public void setUserId(String userId) {        this.userId = userId;        set("user_id", this.userId);    }    public String getUserId() {        this.userId = get("user_id");        return this.userId;    }}

　　如果需要加与数据库表无关属性（例如方便接口接参，添加其他属性），在Model添加，另外，表关联也可以在这里维护

/** * 博客表 Model * * 作者：Auto Generator By 'huanzi-qch' * 生成日期：2021-07-26 09:31:41 */@SuppressWarnings("serial")public class Blog extends BaseBlog<Blog> {    public static final Blog dao = new Blog().dao();    /**     * 表关联操作在这里维护     * User.userId = Blog.userId     */    public Result<User> getUser(String userId){        UserServiceImpl userService = Aop.get(UserServiceImpl.class);        return userService.get(userId);    }}

　　拦截器实现Controller层全局异常处理

/** * Controller层全局异常处理 * 特殊情况外，禁止捕获异常，所有异常都应交给这里处理 */public class GlobalExceptionInterceptor implements Interceptor{    private static Log log = Log.getLog(GlobalExceptionInterceptor.class);    public void intercept(Invocation inv) {        Result result = null;        try {            inv.invoke();        }        //业务异常        catch (ServiceException e){            e.printStackTrace();            result = Result.error(e.getErrorEnum());        }        //空指针、非法参数        catch (NullPointerException | IllegalArgumentException e){            e.printStackTrace();            result = Result.error(ErrorEnum.INTERNAL_SERVER_ERROR);        }                //...                //未知异常（放在最后）        catch (Exception e){            e.printStackTrace();            result = Result.error(ErrorEnum.UNKNOWN);        }        if(StrKit.notNull(result)){            inv.getController().renderJson(result);        }    }}

　　需要在AppConfig中配置Routes级别全局拦截器

    /**     * 配置路由     */    public void configRoute(Routes me) {        // 扫描仅会在该包以及该包的子包下进行        me.scan("cn.huanzi.qch.");        //该方法用于配置是否要将控制器父类中的 public方法映射成 action        me.setMappingSuperClass(true);        // 此处配置 Routes 级别的拦截器，可配置多个        me.addInterceptor(new GlobalExceptionInterceptor());    }

　　所有的异常信息都应该在ErrorEnum中维护

/** * 自定义异常枚举类 */public enum ErrorEnum {    //自定义系列    USER_NAME_IS_NOT_NULL(10001,"【参数校验】用户名不能为空"),    PWD_IS_NOT_NULL(10002,"【参数校验】密码不能为空"),    //400系列    BAD_REQUEST(400,"请求的数据格式不符!"),    UNAUTHORIZED(401,"登录凭证过期!"),    FORBIDDEN(403,"抱歉，你无权限访问!"),    NOT_FOUND(404, "请求的资源找不到!"),    //500系列    INTERNAL_SERVER_ERROR(500, "服务器内部错误!"),    SERVICE_UNAVAILABLE(503,"服务器正忙，请稍后再试!"),    //未知异常    UNKNOWN(10000,"未知异常!");    /** 错误码 */    private Integer code;    /** 错误描述 */    private String msg;    ErrorEnum(Integer code, String msg) {        this.code = code;        this.msg = msg;    }    public Integer getCode() {        return code;    }    public String getMsg() {        return msg;    }}

　　测试接口

    Controller        public void errorTest(){        throw new ServiceException(ErrorEnum.USER_NAME_IS_NOT_NULL);    }    public void errorTest2(){        renderJson(blogService.errorTest2());    }    public void errorTest3(){        renderJson(blogService.errorTest3());    }            ServiceImpl    @Override    public String errorTest2() {        int i = 1/0;        return "失败乃成功之母！";    }    @Override    public String errorTest3() {        throw new NullPointerException();    }

　　自定义请求处理器

/** * 自定义处理器 */public class MyActionHandler extends Handler {    public MyActionHandler() {    }    @Override    public void handle(String target, HttpServletRequest request, HttpServletResponse response, boolean[] isHandled) {        //应用路径        request.setAttribute("ctx", request.getContextPath());        Action action = JFinal.me().getAction(target, new String[]{null});        boolean flag = false;        List<String> allActionKeys = JFinal.me().getAllActionKeys();        if(!allActionKeys.contains(target)){            int i = target.lastIndexOf(47);            if (i != -1) {                String substring = target.substring(0, i);                if (!allActionKeys.contains(substring) || action.getControllerPath().equals(substring)) {                    flag = true;                }            }        }        /*            404            其他静态资源可直接访问，但.html页面禁止直接访问         */        if ((target.contains(".html") || !target.contains(".")) && flag) {            try {                response.setCharacterEncoding("UTF-8");                response.setContentType("application/json; charset=utf-8");                PrintWriter out = response.getWriter();                out.print(JsonKit.toJson(Result.error(ErrorEnum.NOT_FOUND)));                out.flush();                out.close();                response.flushBuffer();            } catch (IOException e) {                e.printStackTrace();            }        }else{            this.next.handle(target, request, response, isHandled);        }    }}

　　id不存在新增

　　id存在则更新

　　delete

　　一个简单页面，包括CRUD、分页

　　异常处理

　　统一Controller层接口异常处理

　　非controller接口错误，会跳转去配置好的500.html页面

　　后记

　　习惯了Spring全家桶，一时可能接受不了JFinal的风格，经过改造封装，jfinal-demo项目的编程风格尽量与我们之前的习惯一致

　　JFinal的生态远没有SpringBoot的好，碰到问题基本上靠百度是搜不到什么解决方案的，好在这个框架并不复杂，依赖的东西也很少，大部分都可以按照需要进行魔改、扩展

　　代码开源

　　代码已经开源、托管到我的GitHub、码云：

　　GitHub：

　　码云：

版权声明

作者：huanzi-qch

出处：

若标题中有“转载”字样，则本文版权归原作者所有。若无转载字样，本文版权归作者所有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文链接，否则保留追究法律责任的权利.