第一篇:play手把手教你创建一个博客项目-06.增加特征(tagging)支持
06.增加特征(tagging)支持
我们的博客上线运行后将包含非常多的博文,那么,要想快速找到某篇博文将越来越困难。为了能按主题进行分类,我们将为博客增加tagging支持。
创建Tag(以下简称特征)模型对象
Tag模型类自身其实非常简单:
package models;
import java.util.*;import javax.persistence.*;
import play.db.jpa.*;
@Entity public class Tag extends Model implements Comparable
public String name;
private Tag(String name){ this.name = name;}
public String toString(){ return name;}
public int compareTo(Tag otherTag){ return name.compareTo(otherTag.name);} } 由于我们打算用findOrCreateByName(String name)工厂方法来实现懒散式特征创建或得到这些特征。那么,让我们把它添加到Tag类里: public static Tag findOrCreateByName(String name){ Tag tag = Tag.find(“byName”, name).first();if(tag == null){ tag = new Tag(name);} return tag;} Tagging posts 是时候创建Tag模型与Post模型的关系了,让我们在Post类里创建正确的关系: …
@ManyToMany(cascade=CascadeType.PERSIST)public Set
public Post(User author, String title, String content){ this.comments = new ArrayList
请注意,在这里我们使用了TreeSet以可预知的顺序来保存特征列表(事实上是按字母顺序的,这是基于我们之前compareTo实现)。在这里,我们仅使用单向关系。
同时,我们将添加很多帮助方法来使特征管理简单化,第一个用于tag一个Post: …
public Post tagItWith(String name){ tags.add(Tag.findOrCreateByName(name));return this;} …
下一个用于通过指定的tag找回所有的博文:
…
public static List
findTaggedWith(String tag){ return Post.find(“select distinct p from Post p join p.tags as t where t.name = ?”, tag).fetch();} … 是时候测试这些新代码了,让我们重新启动服务器到测试模式: $ play test 在basicTest类里添加@Test:
@Test public void testTags(){ // Create a new user and save it User bob = new User(“bob@gmail.com”, “secret”, “Bob”).save();
// Create a new post Post bobPost = new Post(bob, “My first post”, “Hello world”).save();Post anotherBobPost = new Post(bob, “Hop”, “Hello world”).save();
// Well assertEquals(0, Post.findTaggedWith(“Red”).size());
// Tag it now bobPost.tagItWith(“Red”).tagItWith(“Blue”).save();anotherBobPost.tagItWith(“Red”).tagItWith(“Green”).save();
// Check assertEquals(2, Post.findTaggedWith(“Red”).size());assertEquals(1, Post.findTaggedWith(“Blue”).size());assertEquals(1, Post.findTaggedWith(“Green”).size());} 检查其是否正常工作。
下面的内容比上面的要难一点
好了,如果打算用多个tag来找回博文又该怎么做?看起来,这样难一点!下面我将给你一些非常有用的JPQL查询,这些查询可能对你的web项目有用: …
public static List
findTaggedWith(String...tags){ return Post.find(“select distinct p from Post p join p.tags as t where t.name in(:tags)group by p.id, p.author, p.title, p.content,p.postedAt having count(t.id)= :size”).bind(“tags”, tags).bind(“size”, tags.length).fetch();} …
最棘手的部分就是我们必须使用having count语句来对联合查询视图进行过滤,仅让完全拥有全部tag的博文通过。
请注意,在这里我们不能使用Post.find(“…”, tags, tags.count)签名进行查询。这是因为tags已经是变量参数(vararg)了。测试程序如下: …
assertEquals(1, Post.findTaggedWith(“Red”, “Blue”).size());assertEquals(1, Post.findTaggedWith(“Red”, “Green”).size());assertEquals(0, Post.findTaggedWith(“Red”, “Green”, “Blue”).size());assertEquals(0, Post.findTaggedWith(“Green”, “Blue”).size());…
特征(tag)云
哪里有tags,哪里就需要一个tag云。让我们在Tag类里添加一个方法来生成tag云:
public static List
…
List
Tag(play): name: Play
Tag(architecture): name: Architecture
Tag(test): name: Test
Tag(mvc): name: MVC …
把这些tag添加到post的数据描述里: …
Post(jeffPost): title: The MVC application postedAt: 2009-06-06 author: jeff tags: architecture Tagged #{list items:_post.tags, as:'tag'} ${tag}${tag_isLast ? '' : ', '} #{/list} #{/elseif} …
创建‘特征相关(tagged with)’页面
现在,我们就可以通过tags(特征)来列出发表的博文。在上面的#{display /} 标签里,我们把链接暂时留为空链接(用#),下面我们将通过一个链接到新创建的listTagged action替换他们: …
-Tagged #{list items:_post.tags, as:'tag'} ${tag}${tag_isLast ? '' : ', '} #{/list} …
在Application控制器里创建listTagged(String tag)action方法: …
public static void listTagged(String tag){ List
posts = Post.findTaggedWith(tag);render(tag, posts);} …
和以前一样,让我们创建一条指定路由以保持URI清晰:
GET /posts/{tag} Application.listTagged 在这里存在一个问题,之前我们创建的路由和上面这条路由有冲突,这两条路由都能匹配同一个URI: GET /posts/{id} Application.show GET /posts/{tag} Application.listTagged 然后,由于我们假定id是数字型的,而tag不是,那么我们就可以很容易的使用正则表达式来限制第1条路由,从而解决这个问题:
GET /posts/{<[0-9]+>id} Application.show GET /posts/{tag} Application.listTagged 最后,我们只需要创建/yabe/app/views/Application/listTagged.html模板,以用于新的listTagged action:
#{extends 'main.html' /} #{set title:'Posts tagged with ' + tag /}
*{********* Title ********* }*
#{if posts.size()> 1}
There are ${posts.size()} posts tagged '${tag}'
#{/if} #{elseif posts}There is 1 post tagged '${tag}'
#{/elseif} #{else}No post tagged '${tag}'
#{/else}*{********* Posts list *********}*
第二篇:play手把手教你创建一个博客项目-08.添加身份认证
08.添加身份认证
在上一节是,我们为应用程序添加了管理区域(administration area)功能,现在我们将在这些管理区域中插入一些身份认证功能。幸运的是,play已经为这个功能准备了一个模块,这个模块叫Secure(安全)。
在程序里允许使用Secure模块
在yabe/conf/application.conf文件里允许使用Secure模块,并重启程序: # Import the secure module module.secure=${play.path}/modules/secure 重启后,play应用在控制台显示模块已经成功启动的相关信息。
Secure模块带有一系列默认的路由,需要在yabe/conf/routes里引入(或定义自己的路由也行): # Import Secure routes * / module:secure 保护admin(此处指需要身份认证的)控制器
安全模块提供了一个controllers.Secure控制器,它声明了所有可能用到的拦截器。当然,我们可以以继承这个控制器的方法获得其拦截器,但是java只允许单继承,这就导致了一些问题。
为了避免单继承带来的限制,我们可以用@With来注释admin控制器,以告诉play去调用相应的拦截器:
package controllers;
import play.*;import play.mvc.*;
@With(Secure.class)public class Posts extends CRUD { } 同样用于Comments, Users和Tags控制器。
Now if you try to access any admin action, you should get a log-in page: 事实上,现在你就可以试着输入任意username/password对看看,它其实并没有对身份进行认证。
定制身份认证处理
应用程序必须提供一个controllers.Secure.Security实例来定制身份认证处理。通过继承这个类来创建我们自己版本的Secure类,我们可以指定如何对用户身份进行认证。
创建yabe/app/controllers/Security.java文件,重写authenticate()方法: package controllers;
import models.*;
public class Security extends Secure.Security {
static boolean authenticate(String username, String password){ return true;} } 既然我们已经拥有了User对象,那么就非常容易实现这个方法: static boolean authenticate(String username, String password){ return User.connect(username, password)!= null;} 现在打开http://localhost:9000/logout进行登录尝试,用户名和密码在initial-data.yml文件里定义,比如bob@gmail.com/secret。
重构管理区域(administration area)
我们之前已经使用CRUD模块来实现管理区域,但是这个管理区域仍然没有集成到博客UI里,接下来我们将在一个新的管理区域上开始工作。这个新的管理区域允许每个作者访问他自己的博客。而超级用户则继续使用完整功能的管理区域。
接下来,让我们为管理部分创建一个新Admin控制器: package controllers;
import play.*;import play.mvc.*;
import java.util.*;
import models.*;
@With(Secure.class)public class Admin extends Controller {
@Before static void setConnectedUser(){ if(Security.isConnected()){ User user = User.find(“byEmail”, Security.connected()).first();renderArgs.put(“user”, user.fullname);} }
public static void index(){ render();} } 重构路由定义yabe/conf/routes: # Administration GET /admin/? Admin.index * /admin module:crud 请注意路由的顺序,第一行就匹配了的http请求相应的action会率先使用,同时忽略在其之下的路由配置。也就是说Admin控制器必须位于第二行之上,第二条路由将匹配所有其他的/admin请求,用于调用CRUD模块页面,否则/admin/将映射到CRUD.index而不是Admin.index。
现在把yabe/app/views/main.html模块里的 ‘Log in to write something’文本修改到Admin.index控制器action:
…
…最后一件事就是为yabe/app/views/Admin/index.html模板文件完成所有的填充工作,让我们从简单的开始: Welcome ${user}!现在回到主页,单击 ‘Log in to write something’链接就回进入样的管理区域页面: 非常好!但是既然我们已经有几个管理区域的页面,那么,我们就应该有一个超级模板以重用代码,让我们创建一个yabe/app/views/admin.html模板:
#{get 'moreStyles' /}
第三篇:play手把手教你创建一个博客项目-03.构建第一个页面
03.构建第一个页面
之前,我们已经编写好了数据模型,是时候为应用程序创建第一个页面了。这个页面只显示当前发表的博文完整内容,同时显示之前发表的博文列表。下面是该页面结构示意图:
在启动时加载默认数据
事实上,在编写第一个页面之前,我们还需要做一些工作。在一个没有任何测试数据的页面上进行工作并不太好,你甚至不能进行任何测试。
为博客程序注入测试数据的一条途径就是在应用程序启动时加载一个固定文件。为了实现这个目的,我们将创建一个引导任务(Bootstrap Job)。一个play job 任务就是一在没有任何http请求的情况下执行一些特定工作,比如在应用程序启动时或指定时间间隔时使用CRON任务。
接下来,让我们创建/yabe/app/Bootstrap.java job文件,使用Fixtures加载一系列默认数据:
import play.*;import play.jobs.*;import play.test.*;
import models.*;
@OnApplicationStart public class Bootstrap extends Job {
public void doJob(){ // 检查数据库是否为空 if(User.count()== 0){ Fixtures.loadModels(“initial-data.yml”);} } } 在这里,我们使用@OnApplicationStart来注释这个Job,用于告诉play我们打算在应用程序启动时同步运行这个任务。
事实上,在DEV和PROD模式下,这个任务的运行情况有所不同。在DEV模式下,play会等待第一个请求达到时才运行任务。因此这个任务会在第一个请求到达时才同步执行,也就是说,如果这个任务失败,你会在浏览器里看到错误消息。在PROD模式里,这个任务将会在应用程序启动时就执行(与play run命令同步),以防止应用程序在启动时发生错误。
你必须在yabe/conf/下创建一个initial-data.yml文件。当然,你也可以重用我们之前在data.yml里定义的内容。
博客主页
这次,我们将真正开始编写主页代码。
还记得程序的第一个页面是如何显示的吗?首先是在routes文件里指定/ URL 将调用controllers.Application.index()action方法,然后这个index()调用render()方法渲染/yabe/app/views/Application/index.html模板。我们将保留这些组件,但是我们会在其中添加代码来加载博文列表并显示。打开/yabe/app/controllers/Application.java控制器并修改index()action来加载博文列表:
package controllers;
import java.util.*;
import play.*;import play.mvc.*;
import models.*;
public class Application extends Controller {
public static void index(){ Post frontPost = Post.find(“order by postedAt desc”).first();List
olderPosts = Post.find(“order by postedAt desc”).from(1).fetch(10);render(frontPost, olderPosts);} } 看到我们是如何向render方法传递对象的吗?通过这种方式,我们就可以在模板里使用相同的名称来访问这些对象了。在上面的代码里,我们在模板里就可以直接使用变量frontPost和olderPosts。
打开/yabe/app/views/Application/index.html并修改,用于显示这些对象: #{extends 'main.html' /} #{set title:'Home' /}
#{if frontPost}