Jkmvc is an elegant, powerful and lightweight MVC web framework built using kotlin. It aims to be swift, secure, and small. It will turn java's heavy development into kotlin's simple pleasure.
Inspired by 2 php frameworks: kohana and skmvc
JkFilter is a Filter for your web application
vim src/main/webapp/WEB-INF/web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
<filter>
<filter-name>jkmvc</filter-name>
<filter-class>com.jkmvc.http.JkFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>jkmvc</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
Controller handles request, and render data to response.
It has property req to represent request, res to represent response.
package com.jkmvc.example.controller
import com.jkmvc.http.Controller
/**
* 主页
*/
class WelcomeController: Controller() {
/**
* 主页
*/
public fun indexAction() {
res.render("hello world");
}
}
configure controller classes's package paths
vim src/main/resources/http.yaml
# controller类所在的包路径
# controller classes's package paths
controllerPackages:
- com.jkmvc.example.controller
visit http://localhost:8081/jkmvc-example/
vim
package com.jkmvc.example.controller
import com.jkmvc.http.Controller
/**
* 主页
*/
class WelcomeController: Controller() {
/**
* 显示jsp视图
* render jsp view
*/
public fun jspAction(){
res.render(view("index" /* view file */, mutableMapOf("name" to "shijianhang") /* view data */))
}
}
I regret that we cannot write kotlin in jsp.
vim src/main/webapp/index.jsp
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>jkmvc</title>
</head>
<body>
Hello <%= request.getAttribute("name") %><br/>
</body>
</html>
visit http://localhost:8081/jkmvc/welcome/jsp
Orm provides object-oriented way to mainpulate db data.
It has 2 concepts:
1 Orm meta data: include information as follows
1.1 mapping from object to table
1.2 mapping from object's property to table's column
1.3 mapping from object's property to other object
2 Orm object | Model
2.1 visit property
you can use operator [] to visit orm object's property, and also use property delegate public var id:Int by property<Int>(); to visit it
2.2 method
query_builder() return a query builder to query data from table
create() create data
update() update data
delete() delete data
user table
CREATE TABLE `user` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '用户编号',
`name` varchar(50) NOT NULL DEFAULT '' COMMENT '用户名',
`age` tinyint(4) unsigned NOT NULL DEFAULT '0' COMMENT '年龄',
`avatar` varchar(250) DEFAULT NULL COMMENT '头像',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=35 DEFAULT CHARSET=utf8 COMMENT='用户'
address table
CREATE TABLE `address` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '地址编号',
`user_id` int(11) unsigned NOT NULL COMMENT '用户编号',
`addr` varchar(50) NOT NULL DEFAULT '' COMMENT '地址',
`tel` varchar(50) NOT NULL DEFAULT '' COMMENT '电话',
`name` varchar(50) NOT NULL DEFAULT '' COMMENT '用户名',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=29 DEFAULT CHARSET=utf8 COMMENT='地址';
use model, extends Orm
package com.jkmvc.example.model
import com.jkmvc.orm.OrmMeta
import com.jkmvc.orm.Orm
/**
* 用户模型
* User model
*/
class UserModel(id:Int? = null): Orm(id) {
// 伴随对象就是元数据
// company object is meta data for model
companion object m: OrmMeta(UserModel::class){
init {
// 添加标签 + 规则
// add label and rule for field
addRule("name", "姓名", "notEmpty");
addRule("age", "年龄", "between(1,120)");
// 添加关联关系
// add relaction for other model
hasOne("address", AddressModel::class)
hasMany("addresses", AddressModel::class)
}
}
// 代理属性读写
// delegate property
public var id:Int by property<Int>();
public var name:String by property<String>();
public var age:Int by property<Int>();
public var avatar:String? by property<String?>();
// 关联地址：一个用户有一个地址
// relate to AddressModel: user has an address
public var address:AddressModel by property<AddressModel>();
// 关联地址：一个用户有多个地址
// relate to AddressModel: user has many addresses
public var addresses:List<AddressModel> by property<List<AddressModel>>();
}
address model, extends Orm
package com.jkmvc.example.model
import com.jkmvc.orm.OrmMeta
import com.jkmvc.orm.Orm
/**
* 地址模型
*/
class AddressModel(id:Int? = null): Orm(id) {
// 伴随对象就是元数据
// company object is meta data for model
companion object m: OrmMeta(AddressModel::class){
init {
// 添加标签 + 规则
// add label and rule for field
addRule("user_id", "用户", "notEmpty");
addRule("addr", "地址", "notEmpty");
addRule("tel", "电话", "notEmpty && digit");
// 添加关联关系
// add relaction for other model
belongsTo("user", UserModel::class, "user_id")
}
}
// 代理属性读写
// delegate property
public var id:Int by property<Int>();
public var user_id:Int by property<Int>();
public var addr:String by property<String>();
public var tel:String by property<String>();
// 关联用户：一个地址从属于一个用户
public var user:UserModel by property<UserModel>()
}
package com.jkmvc.example.controller
import com.jkmvc.example.model.UserModel
import com.jkmvc.http.Controller
import com.jkmvc.orm.isLoaded
import java.io.File
/**
* 用户管理
* user manage
*/
class UserController: Controller()
{
/**
* 列表页
* list page
*/
public fun indexAction()
{
// 查询所有用户 | find all users
val users = UserModel.queryBuilder().findAll<UserModel>()
// 渲染视图 | render view
res.render(view("user/index", mutableMapOf("users" to users)))
}
/**
* 详情页
* detail page
*/
public fun detailAction()
{
// 获得路由参数id: 2种写法 | 2 ways to get route parameter: "id"
// val id = req.getIntRouteParameter("id"); // req.getRouteParameter["xxx"]
val id:Int? = req["id"] // req["xxx"]
// 查询单个用户 | find a user
//val user = UserModel.queryBuilder().where("id", id).find<UserModel>()
val user = UserModel(id)
if(!user.isLoaded()){
res.render("用户[$id]不存在")
return
}
// 渲染视图 | render view
val view = view("user/detail")
view["user"] = user; // 设置视图参数 | set view data
res.render(view)
}
/**
* 新建页
* new page
*/
public fun newAction()
{
// 处理请求 | handle request
if(req.isPost()){ // post请求：保存表单数据 | post request: save form data
// 创建空的用户 | create user model
val user = UserModel()
// 获得请求参数：3种写法 | 3 ways to get request parameter
/* // 1 req.getParameter("xxx");
user.name = req.getParameter("name")!!;
user.age = req.getIntParameter("age", 0)!!; // 带默认值 | default value
*/
// 2 req["xxx"]
user.name = req["name"]!!;
user.age = req["age"]!!;
// 3 Orm.requestValues(req)
user.requestValues(req)
user.create(); // create user
// 重定向到列表页 | redirect to list page
redirect("user/index");
}else{ // get请求： 渲染视图 | get request: render view
val view = view() // 默认视图为action名： user/new | default view's name = action： user/new
res.render(view)
}
}
/**
* 编辑页
* edit page
*/
public fun editAction()
{
// 查询单个用户 | find a user
val user = UserModel(req["id"])
if(!user.isLoaded()){
res.render("用户[" + req["id"] + "]不存在")
return
}
// 处理请求 | handle request
if(req.isPost()){ // post请求：保存表单数据 | post request: save form data
// 获得请求参数：3种写法 | 3 way to get request parameter
/* // 1 req.getParameter("xxx");
user.name = req.getParameter("name")!!;
user.age = req.getIntParameter("age", 0)!!; // 带默认值 | default value
*/
/*// 2 req["xxx"]
user.name = req["name"]!!;
user.age = req["age"]!!;
*/
// 3 Orm.requestValues(req)
user.requestValues(req)
user.update() // update user
// 重定向到列表页 | redirect to list page
redirect("user/index");
}else{ // get请求： 渲染视图 | get request: render view
val view = view() // 默认视图为action名： user/edit | default view's name = action： user/edit
view["user"] = user; // 设置视图参数 | set view data
res.render(view)
}
}
/**
* 删除
* delete action
*/
public fun deleteAction()
{
val id:Int? = req["id"]
// 查询单个用户 | find a user
val user = UserModel(id)
if(!user.isLoaded()){
res.render("用户[$id]不存在")
return
}
// 删除 | delete user
user.delete();
// 重定向到列表页 | redirect to list page
redirect("user/index");
}
/**
* 上传头像
* upload avatar
*/
public fun uploadAvatarAction()
{
// 设置上传的子目录（将上传文件保存到指定的子目录），必须要在调用 req 的其他api之前调用，否则无法生效
// set uploadSubdir which uploaded file is saved, you must set it before calling req's other api, or it's useless
req.uploadSubdir = "avatar/" + Date().format("yyyy/MM/dd")
// 查询单个用户 | find a user
val id: Int = req["id"]!!
val user = UserModel(id)
if(!user.isLoaded()){
res.render("用户[" + req["id"] + "]不存在")
return
}
// 检查并处理上传文件 | check and handle upload request
if(req.isUpload()){ // 检查上传请求 | check upload request
user.avatar = req.getFileRelativePath("avatar")
user.update()
}
// 重定向到详情页 | redirect to detail page
redirect("user/detail/$id");
}
}
download source and run web server
git clone https://github.com/shigebeyond/kotlin-jkmvc.git
cd kotlin-jkmvc
gradle :jkmvc-example:jettyRun
visit url
http://localhost:8081/jkmvc/user/index
http://localhost:8081/jkmvc/user/detail
http://localhost:8081/jkmvc/user/new
http://localhost:8081/jkmvc/user/edit
gradle :jkmvc-common:build -x test
gradle :jkmvc-orm:build -x test
gradle :jkmvc-http:build -x test
gradle :jkmvc-example:build -x test