Latke 在设计原理上非常类似 Spring,是 Spring 的极简版,该文档适合 Java Web 应用 框架初学者 以及 Latke 应用开发者,大家在看文档的同时,欢迎提出问题、评论。 概述 [链接]('lɑ:tkə,土豆饼)是一个简单易用的 Java Web 应用开发框架,包含 MVC、IoC/AOP、事件 ..

Latke 快速上手指南

本贴最后更新于 228 天前,其中的信息可能已经天翻地覆

Latke 在设计原理上非常类似 Spring,是 Spring 的极简版,该文档适合 Java Web 应用 框架初学者 以及 Latke 应用开发者,大家在看文档的同时,欢迎提出问题、评论。

概述

Latke('lɑ:tkə,土豆饼)是一个简单易用的 Java Web 应用开发框架,包含 MVC、IoC/AOP、事件通知、ORM、插件等组件。

在实体模型上使用 JSON 贯穿前后端,使应用开发更加快捷。这是 Latke 不同于其他框架的地方,非常适合小型应用的快速开发, 为什么又要造一个叫 Latke 的轮子

核心组件

Hello World!

Demo 项目完整代码: https://github.com/b3log/latke-demo

项目结构

└─hello
    │  nb-configuration.xml
    │  nbactions.xml
    │  pom.xml
    │
    └─src
        └─main
            ├─java
            │  └─org
            │      └─b3log
            │          └─latke
            │              └─demo
            │                  └─hello
            │                      │  HelloServletListener.java
            │                      │  Starter.java
            │                      │
            │                      ├─processor
            │                      │      HelloProcessor.java
            │                      │      RegisterProcessor.java
            │                      │
            │                      ├─repository
            │                      │      UserRepository.java
            │                      │
            │                      └─service
            │                              UserService.java
            │
            ├─resources
            │  │  latke.properties
            │  │  local.properties
            │  │  log4j.properties
            │  │  repository.json
            │  │
            │  └─META-INF
            │          beans.xml
            │
            └─webapp
                ├─skins
                │  └─classic
                │      │  hello.ftl
                │      │  index.ftl
                │      │  register.ftl
                │      │
                │      └─images
                │              logo.png
                │
                └─WEB-INF
                        static-resources.xml
                        web.xml

请求处理

客户端的 HTTP 请求会经过 Latke 分发到应用定义的请求处理器上(标注有 @RequestProcessor 的类),一个请求处理器可以包含多个请求处理方法(标注有 @RequestProcessing 的方法), 每个方法可以对应多个请求地址。可以看作是 SpringMVC 中控制器的简要实现,略有不同的是在响应的处理上。

@RequestProcessor
public class HelloProcessor {

    @RequestProcessing(value = {"/", "/index"}, method = HttpMethod.GET)
    public void index(final RequestContext context) {
        final AbstractFreeMarkerRenderer render = new SimpleFMRenderer();
        context.setRenderer(render);
        render.setTemplateName("index.ftl");

        final Map<String, Object> dataModel = render.getDataModel();
        dataModel.put("greeting", "Hello, Latke!");

        Requests.log(context.getRequest(), Level.DEBUG, LOGGER);
    }

    @RequestProcessing(value = "/greeting", method = {HttpMethod.GET, HttpMethod.POST})
    public void greeting(final RequestContext context) {
        final AbstractFreeMarkerRenderer render = new SimpleFMRenderer();
        context.setRenderer(render);
        render.setTemplateName("hello.ftl");

        final Map<String, Object> dataModel = render.getDataModel();
        dataModel.put("time", new Date());
        final String name = context.param("name");
        if (StringUtils.isNotBlank(name)) {
            dataModel.put("name", name);
        }
    }
}

通过使用不同的响应渲染器可以生成不同类型的响应,例如 HTML、Rss、PNG 等。

服务调用

通过 @Inject 注入需要的服务:

@RequestProcessor
public class RegisterProcessor {

    @Inject
    private UserService userService;

    @RequestProcessing(value = "/register")
    public void showRegister(final RequestContext context) {
        final AbstractFreeMarkerRenderer render = new SimpleFMRenderer();
        context.setRenderer(render);
        render.setTemplateName("register.ftl");
    }

    public void register(final RequestContext context) { // 函数式路由,在 HelloServletListener 中配置
        final AbstractFreeMarkerRenderer render = new SimpleFMRenderer();
        context.setRenderer(render);
        render.setTemplateName("register.ftl");
        final Map<String, Object> dataModel = render.getDataModel();

        final HttpServletRequest request = context.getRequest();
        final String name = request.getParameter("name");
        if (StringUtils.isNotBlank(name)) {
            dataModel.put("name", name);

            userService.saveUser(name, 3);
        }
    }
}

服务实现

@Service
public class UserService {

    private static final Logger LOGGER = Logger.getLogger(UserService.class.getName());

    @Inject
    private UserRepository userRepository;

    @Transactional
    public void saveUser(final String name, final int age) {
        final JSONObject user = new JSONObject();
        user.put("name", name);
        user.put("age", age);

        String userId;

        try {
            userId = userRepository.add(user);
        } catch (final RepositoryException e) {
            LOGGER.log(Level.ERROR, "Saves user failed", e);

            // Throws an exception to rollback transaction
            throw new IllegalStateException("Saves user failed");
        }

        LOGGER.log(Level.INFO, "Saves a user successfully [userId={0}]", userId);
    }
}

DAO

@Repository
public class UserRepository extends AbstractRepository {

    public UserRepository() {
        super("user");

        // Generates database tables
        JdbcRepositories.initAllTables();
    }
}

注意:初始化表 JdbcRepositories.initAllTables() 最好通过单独的初始化程序来做,调用这个方法后会根据 repository.json 的描述生成建表 SQL 并执行。

最佳实践

表名前缀

在 local.properties 中有一项配置 jdbc.tablePrefix,如果配置了该项,则初始化表(JdbcRepositories.initAllTables())时生成的表名就会带有前缀。

建议应用配置该项,以屏蔽不同数据库迁移数据时关键字对表名的影响。

实体模型

Lakte 使用 JSON 作为实体载体,管理 JSON 的键就是对实体的建模。实体的键对应了数据库表列名,实体内嵌的关联对象是服务中组装的。例如对于“用户”实体,键包含了简单类型属性:“name”、“age”,关联类型属性:”books”,构造的对象例如:

{
        “name”: “Daniel”,
        “age”: 23,
        “books”: [{
                “name”: “TAO of Life”
        }, ….]
}

键管理可以通过 User 类:

public class User {
    public static final String USER_NAME = “name”;
    public static final String USER_AGE = “age”;
    public static final String USER_T_BOOKS = “books”;
}

T(Transient) 表示这个属性是非持久化的(User 表中无此列),是通过在服务中组装而来的。

repository.json

这个文件可以手工编写,然后使用 JdbcRepositories#initAllTables 方法自动创建数据库;也可以使用 JdbcRepositories#initRepositoryJSON 方法从已有数据库表生成这个文件。

repository.json -> tables:

tables -> repository.json:

这两种方式没有什么本质上的区别,可由开发自由决定。

关联查询

实体 JSON 对象中的关联属性是通过组装而来,需要先把这个属性查询出来,再编程组装到这个实体 JSON 对象中。这一点相对于一些 ORM 框架(例如 Hibernate)来说是比较繁琐,但这样做的优势之一就是能够使实体变得更灵活、更容易加入缓存优化性能。

也支持自定义 SELECT SQL,请参考接口 repository#select。

  • Latke

    Latke 是一款以 JSON 为主的 Java Web 框架。

    50 引用 • 365 回帖 • 515 关注
  • Java

    Java 是一种可以撰写跨平台应用软件的面向对象的程序设计语言,是由 Sun Microsystems 公司于 1995 年 5 月推出的。Java 技术具有卓越的通用性、高效性、平台移植性和安全性。

    2212 引用 • 7525 回帖 • 963 关注
  • 框架
    27 引用 • 249 回帖
  • MVC
    7 引用 • 104 回帖
优质回帖
  • ydcun 1 赞同      

    希望能为这个轮子做点贡献

  • umeone 1 赞同      

    不错,以前还真没这么去想过,准备研究一下。。

  • 88250 1 赞同    

    可行的,等后面有空再加吧。

69 回帖   
请输入回帖内容...
  • lucky  

    我尝试创建了一张表写了一个添加的功能,结果报了这个错误。

    [ERROR]-[2018-09-14 21:51:19]-[com.vseu.blog.processor.console.SentenceConsole:62]: org.b3log.latke.repository.RepositoryException: com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'from,oId,type,gmt_modified) values ('2018-09-14 21:51:19.952','天空本是一' at line 1
    [ERROR]-[2018-09-14 21:51:29]-[org.b3log.latke.repository.jdbc.JdbcRepository:151]: Add failed
    com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'from,oId,type,gmt_modified) values ('2018-09-14 21:51:29.937','你永远也看' at line 1
    	at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
    	at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:62)
    	at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
    	at java.lang.reflect.Constructor.newInstance(Constructor.java:423)
    
    

    这个字段的顺序和我在数据库或 model 中的顺序不同,repository.json 已按照上面的 demo 写了,无法打印 sql,搞不清是哪里错了 。 求助大佬

    from,oId,type,gmt\_modified) values ('2018-09-14 21:51:29.937','你永远也看'
    
    1 回复
  • 88250 1 赞同      

    改下 log4j 的配置就可以打印 SQL 了。

    log4j.logger.org.b3log.latke.repository.jdbc.util=TRACE
    
  • lucky  

    请问,访问 http://127.0.0.1:8080/articles/1537552669251.html 的时候会映射到@RequestProcessing(value \= "/article", method \= HTTPRequestMethod.GET)而不会映射到@RequestProcessing(value \= "/articles/*", method \= HTTPRequestMethod.GET)
    这是在哪里匹配的呢?

    1 回复
  • 88250      

    从 PermalinkFilter.java 看起。

    1 回复
  • lucky        

    我想再问一下 tags.html 这个映射到哪里了,直接放回页面的话 tags 的值是哪来的 = =

    1 回复
  • 88250      

    UserTemplateProcessor.java

  • Ahian  

    真的有必要研究研究这个框架👍

  • a7223923  

    666666,现在正在研究这个源码哈哈。

  • MonkeyL  

    你好,请问如何才能成为 latke 开源项目的 contributor 呢?想贡献一些代码😄

    1 回复
  • 88250      

    请参考 Latke 贡献指南

  • yangyu1  

    新手上路 有没有大佬可以发一下详细的文档 表示很多方法根本看不懂😭

  • chenzexin  

    如果是使用其他数据库,怎么办?需要重写 latke-core 吗?

    1 回复
  • 88250      

    引用不同的 repository 支持即可,目前支持 H2、MySQL、Oracle、SQLServer,具体可以看下 Latke 的项目代码。

  • chenzexin  

    AGPL 的相关条款是什么?这个免费给个人使用吗?

    1 回复
  • 88250      

    可以免费甚至商用,但必须开源所有代码。

  • skqing  

    既然使用 JSON,那为什么不使用 MongoDB 呢?

    1 回复
  • 88250      

    很早之前考虑过,不过当时 MongoDB 还不那么流行。现在等有时间会实现一下,很容易扩展的。

  • brandim  

    事件通知 有使用介绍没???

    1 回复
  • 88250      

    那个是个简单的观察者模式实现,基本是参考 JDK 代码实现的。具体使用示例可以参考 Solo 或者 Sym 里的代码。

请输入回帖内容 ...