浏览代码

Merge pull request #1 from zhoulei-kid/readme

well done
James Zhan 13 年之前
父节点
当前提交
d336a93f19
共有 2 个文件被更改,包括 91 次插入69 次删除
  1. 0 69
      README.md
  2. 91 0
      README.rst

+ 0 - 69
README.md

@@ -1,69 +0,0 @@
-JFinal 是基于Java 语言的极速 WEB + ORM 开发框架,其核心设计目标是开发迅速、代码量少、学习简单、功能强大、轻量级、易扩展、Restful。在拥有Java语言所有优势的同时再拥有ruby、python等动态语言的开发效率!为您节约更多时间,去陪恋人、家人和朋友 ;)
-==JFinal主要特点:==
- * MVC架构,设计精巧,使用简单
- * 遵循COC原则,零配置,无xml
- * ActiveRecord支持,使数据库开发极致快速
- * 自动加载修改后的java文件,开发过程中无需重启web server
- * AOP支持,拦截器配置灵活,功能强大
- * Plugin体系结构,扩展性强
- * 多视图支持,支持FreeMarker、JSP、Velocity
- * 强大的Validator后端校验功能
- * 功能齐全,拥有struts2的绝大部分功能
- * 体积小仅180K,且无第三方依赖
-
-以下是JFinal实现Blog管理的代码:
-{{{
-/**
- * BlogController
- */
-public class BlogController extends Controller {
-	public void index() {
-		setAttr("blogList", Blog.dao.find("select * from blog order by id asc"));
-	}
-	
-	public void add() {
-	}
-	
-	@Before(BlogValidator.class)
-	public void save() {
-		getModel(Blog.class).save();
-	}
-	
-	public void edit() {
-		setAttr("blog", Blog.dao.findById(getParaToInt()));
-	}
-	
-	@Before(BlogValidator.class)
-	public void update() {
-		getModel(Blog.class).update();
-	}
-	
-	public void delete() {
-		Blog.dao.deleteById(getParaToInt());
-	}
-}
-
-
-/**
- * Blog model.
- */
-public class Blog extends Model<Blog> {
-	public static final Blog dao = new Blog();
-}
-
-
-/**
- * BlogValidator.
- */
-public class BlogValidator extends Validator {
-	protected void validate(Controller controller) {
-		validateRequiredString("blog.title", "titleMsg", "请输入Blog标题!");
-		validateRequiredString("blog.content", "contentMsg", "请输入Blog内容!");
-	}
-	
-	protected void handleError(Controller controller) {
-		controller.keepModel(Blog.class);
-	}
-}
-
-}}}

+ 91 - 0
README.rst

@@ -0,0 +1,91 @@
+===========================
+JAVA 极速WEB+ORM框架 JFinal
+===========================
+
+    JFinal 是基于 Java 语言的极速 WEB + ORM 框架,其核心设计目标是开发迅速、代码量少、学习简单、功能强大、轻量级、易扩展、Restful。在拥有Java语言所有优势的同时再拥有ruby、python等动态语言的开发效率!为您节约更多时间,去陪恋人、家人和朋友 ;)
+
+JFinal有如下主要特点
+------------------------
+#. MVC架构,设计精巧,使用简单
+#. 遵循COC原则,零配置,无xml
+#. ActiveRecord支持,使数据库开发极致快速
+#. 自动加载修改后的java文件,开发过程中无需重启web server
+#. AOP支持,拦截器配置灵活,功能强大
+#. Plugin体系结构,扩展性强
+#. 多视图支持,支持FreeMarker、JSP、Velocity
+#. 强大的Validator后端校验功能
+#. 功能齐全,拥有struts2的绝大部分功能
+#. 体积小仅198K,且无第三方依赖
+
+**JFinal 极速开发QQ群欢迎您的加入: 222478625**
+
+**以下是JFinal实现Blog管理的示例:**
+
+**1. 控制器(支持FreeMarker、JSP、Velocity、JSON等等以及自定义视图渲染)**
+
+:: 
+ 
+    @Before(BlogInterceptor.class)
+    public class BlogController extends Controller {
+        public void index() {
+            setAttr("blogList", Blog.dao.find("select * from blog"));
+        }
+        public void add() {
+        }
+	
+        @Before(BlogValidator.class)
+        public void save() {
+            getModel(Blog.class).save();
+        }
+	
+        public void edit() {
+            setAttr("blog", Blog.dao.findById(getParaToInt()));
+        }
+	
+        @Before(BlogValidator.class)
+        public void update() {
+            getModel(Blog.class).update();
+        }
+	
+        public void delete() {
+            Blog.dao.deleteById(getParaToInt());
+        }
+    }
+
+**2.Model(无xml、无annotaion、无attribute、无getter、无setter、new
+Blog()这行代码也不是必须)**
+:: 
+  
+     public class Blog extends Model {
+           public static final Blog dao = new Blog();
+     }
+
+**3.Validator(API引导式校验,比xml校验方便N倍,有代码检查不易出错)**
+
+::
+
+    public class BlogValidator extends Validator {
+        protected void validate(Controller controller) {
+            validateRequiredString("blog.title", "titleMsg", "请输入Blog标题!");
+            validateRequiredString("blog.content", "contentMsg", "请输入Blog内容!");
+        }
+	
+        protected void handleError(Controller controller) {
+            controller.keepModel(Blog.class);
+        }
+    }
+
+**4.拦截器(在此demo中仅为示例,本demo不需要此拦截器)**
+
+::
+   
+    public class BlogInterceptor implements Interceptor {
+        public void intercept(ActionInvocation ai) {
+            System.out.println("Before invoking " + ai.getActionKey());
+            ai.invoke();
+            System.out.println("After invoking " + ai.getActionKey());
+        }
+    }
+
+
+Javadoc: http://www.osctools.net/apidocs/apidoc?api=jfinal