月度归档:2016年10月

用 Nginx 来做私有 docker registry 的安全控制

docker registry 就是管理 docker 镜像的服务, Docker 公司维护的 registry 就是 http://hub.docker.com ,它可以让我们方便的下载预先做好的镜像。这篇博客把作者做的一些实验分享给大家,让你也能在docker环境下起这些服务体会一下,再简单解释一下是如何用nginx来怎么这些问题。

AD:51CTO 网+ 第十二期沙龙:大话数据之美_如何用数据驱动用户体验

docker registry 介绍

docker registry 就是管理 docker 镜像的服务, Docker 公司维护的 registry 就是 http://hub.docker.com ,它可以让我们方便的下载预先做好的镜像。

  1. $ docker pull ubuntu

上面的命令就是缺省的从这个Docker官方源下载。在国内为了加快访问,你也可以使用docker.cn 的服务,他们同步了常用的镜像,使用也非常方便,如:

  1. $ docker pull docker.cn/docker/ubuntu

大部分公司在推广使用 docker 时,都会为了使用方便,在公司内部自己架设一个,不仅仅是为了安全、节省大量的带宽,而且也可以有效推动内部对docker的有效利用,如下图:

alt

Docker公司的 docker registry也是开源的,我们可以很容易的架设自己的私有docker registry,启动时典型的docker方式,就是:

  1. $ docker run -d -p 5000:5000 registry

使用也很简单了,下面的命令就是把官方的ubuntu镜像放在私有的registry:

  1. $ docker tag ubuntu company.com:5000/ubuntu
  2. $ docker push company.com:5000/ubuntu

不过他有以下几个问题:

  • registry缺省没有安全权限的设置,任何人都可以pull、push,这个基本上是不能接受的。
  • 十月发布的docker 1.3.x版本的发布有很多新的功能,但也强制基本鉴定(basic authentication)必须使用https,极其烦人。

这篇博客就把作者做的一些实验分享给大家,让你也能在docker环境下起这些服务体会一下,再简单解释一下是如何用nginx来怎么这些问题。所有的实验都是在Windows boot2docker的环境下完成,理解后在其他docker环境应该也一样。

先会把成功的环境演示一下,后面再把其中的技术稍微解释一下。

演示环境说明

让我们先来看看这个nginx+registry的服务是怎么组成的。

alt

dokk.co 这是docker服务器的名字也就是你的公司docker私有服务器的地址,因为https的SSL证书不能用IP地址,我就随便找了个名字,做实验没有问题。

registry 服务器作为上游服务器处理docker镜像的最终上传和下载,用的是官方的镜像。

nginx 是一个用nginx作为反向代理服务器,通过模块提供https的ssl的认证和basic authentication,加上必要的配置,用的是我自己做的一个镜像 larrycai/nginx-auth-proxy 。

这里可以看到典型的互联网服务,nginx把这些https、认证服务搞定,registry关注docker的镜像服务就可以了。

可以很方便的启动这些服务,命令如下:

  1. $ docker run -d --name registry -p 5000:5000 registry
  2. $ docker run -d --name nginx --link registry:registry -p 443:443 larrycai/nginx-auth-proxy

命令稍加解释一下

--name registry:这是docker的容器链接(link)技术,为了方便 nginx 容器的访问 registry(对应 --link registry:registry ),稍后还有解释。
-p 5000:5000 registry 作为上游服务器,这个 5000 端口可以不用映射出来,因为所有的外部访问都是通过前端的nginx来提供,nginx 可以在私有网络访问 registry 。端口映射出来只是为了方便调试,确保查看 registry 是否独立也能工作。
-p 443:443 就是对外服务的https端口。

尝试

多说无益,尝试一下,看看到底现在可以能做啥了。
Registry服务

先验证 registry 是否正常:

  1. $ docker pull hello-world # 这个hello world包很小,适合做实验
  2. $ docker tag hello-world localhost:5000/hello-world
  3. $ docker push localhost:5000/hello-world
  4. The push refers to a repository [localhost:5000/hello-world] (len: 1)
  5. Sending image list
  6. Pushing repository localhost:5000/hello-world (1 tags)
  7. 511136ea3c5a: Image successfully pushed
  8. 7fa0dcdc88de: Image successfully pushed
  9. ef872312fe1b: Image successfully pushed
  10. Pushing tag for rev [ef872312fe1b] on {http://localhost:5000/v1/repositories/hello-world/tags/latest}

结果一切正常,registry已经能提供后端的 docker registry 服务了。

docker的HTTPS服务

现在看看nginx的https服务怎么样,先用curl命令。( larrycai:passwd 是我预先放置的用户和密码)

  1. $ curl -i -k https://larrycai:passwd@dokk.co

  1. curl: (6) Couldn't resolve host 'dokk.co'

对了,这是自己杜撰的域名,需要在 /etc/hosts的localhost 后面加上 dokk.co ,如下。

  1. $ cat /etc/hosts
  2. 127.0.0.1 boot2docker localhost localhost.local dokk.co

再来一次尝试一下

  1. $ curl -i -k https://larrycai:passwd@dokk.co
  2. HTTP/1.1 200 OK
  3. Server: nginx/1.6.2
  4. Date: Sat, 29 Nov 2014 09:21:18 GMT
  5. Content-Type: application/json
  6. Content-Length: 28
  7. Connection: keep-alive
  8. Expires: -1
  9. Pragma: no-cache
  10. Cache-Control: no-cache
  11. "\"docker-registry server\""

说明连通了 nginx 和 registry 。说句实话,以前我没玩过nginx,看到这么简单,还是有点小激动,这么容易。

实际上也打开浏览器访问 https://192.168.59.103 , 192.168.59.103是 boot2docker 的VM的IP地址(你可以换成你的docker机器的IP地址)alt

忽略安全告警后,输入用户名和密码 larrycai:passwd ,还是正确的访问到了上游的registry了。我用的是chrome,如果是IE,可能会要你存盘才能看到 "\"docker-registry server\"" 这行字符串。

docker 的 login 服务

如果我们希望 docker push 需要访问控制的话,在docker中是通过 docker login 先来登录的,成功后的配置信息存放在 ~/.dockercfg 。

先来试试不登录的情况:

  1. $ docker tag hello-world dokk.co/hello-world
  2. $ docker push dokk.co/hello-world
  3. The push refers to a repository [dokk.co/hello-world] (len: 1)
  4. Sending image list

看上去没啥反应,也没报啥错,但是明显没有 push 上去,再去docker的log( /var/lib/boot2docker/docker.log )中查查

  1. docker@boot2docker:~$ tail -f /var/lib/boot2docker/docker.log
  2. [debug] http.go:162 https://dokk.co/v1/repositories/hello-world/ -- HEADERS: map[User-Agent:[docker/1.3.2 go/go1.3.3 git-commit/39fa2fa kernel/3.16.7-tinycore64 os/linux arch/amd64] Authorization:[Basic Og==]]
  3. Error: Status 401 trying to push repository hello-world: <html>
  4. <head><title>401 Authorization Required</title></head>
  5. <body bgcolor="white">
  6. <center><h1>401 Authorization Required</h1></center>
  7. <hr><center>nginx/1.6.2</center>
  8. </body>
  9. </html>
  10. [00246b13] -job push(dokk.co/hello-world) = ERR (1)

可以发现提示需要鉴权,和预想的一样(这里要理解是docker的daemon和registry交互而不是docker客户)

好吧,先用docker登陆是否成功。

  1. $ docker login -u larrycai -p passwd -e test@gmail.com dokk.co
  2. 2014/11/29 12:42:12 Error response from daemon: Server Error: Post https://dokk.co/v1/users/: x509: certificate signed by unknown authority

OMG,镜像内部放的自签名证书它不相信,我们需要把服务器的根证书在docker这端自己认证一下。

让我们把我做 dokk.co 的根证书 ca.pem 下载下来,再加入到 boot2docker 的证书( /etc/ssl/certs/ca-certificates.crt )中。当然为了演示方便, ca.pem 已经放在容器中了,你可以直接把它拷贝出来。( docker cp 是个好命令,别忘了)

  1. $ docker cp nginx:/ca.pem $PWD
  2. $ cat ca.pem | sudo tee -a /etc/ssl/certs/ca-certificates.crt

不好意思,证书是docker的daemon需要用到的,docker服务需要重启。先停掉服务是个好习惯(体会到加 --name 的好处了吧)。

  1. $ docker rm -f registry nginx
  2. $ sudo /etc/init.d/docker restart

然后再次运行registry和nginx服务,然后 login

  1. $ docker run -d --name registry -p 5000:5000 registry
  2. $ docker run -d --name nginx --link registry:registry -p 443:443 larrycai/nginx-auth-proxy
  3. $ docker login -u larrycai -p passwd -e test@gmail.com dokk.co
  4. Login Succeeded

再上传试试

  1. $ docker tag hello-world dokk.co/hello-world
  2. $ docker push dokk.co/hello-world
  3. Sending image list
  4. Pushing repository dokk.co/hello-world (1 tags)
  5. 511136ea3c5a: Image successfully pushed
  6. 7fa0dcdc88de: Image successfully pushed
  7. ef872312fe1b: Image successfully pushed
  8. Pushing tag for rev [ef872312fe1b] on {https://dokk.co/v1/repositories/hello-world/tags/latest}

一切完美,测试结束,永远的v5。

技术讨论

现在来简单过一遍一些技术要点,不懂nginx的话也没多大关系,看懂关键点,多做实验。

basic auth

  1. 可以在 Dockerfile 中看到 nginx 编译的时候加载了 http_auth_request 模块
  2. RUN curl -s http://nginx.org/download/nginx-1.6.2.tar.gz | tar -xz -C /tmp \
  3. && cd /tmp/nginx-1.6.2 \
  4. && ./configure --with-http_ssl_module --with-http_auth_request_module && make && make install

然后在 nginx.conf 中配好用户名密码文件 docker-registry.htpasswd ,这个文件是有 htpasswd 命令产生。

  1. location / {
  2. auth_basic "Restricted";
  3. auth_basic_user_file docker-registry.htpasswd; # larrycai:passwd
  4. proxy_pass http://docker-registry;
  5. }

你可以试着进入 nginx 容器,运行 htpasswd 命令( docker exec 也是一个神奇的命令)

  1. $ docker exec -it nginx bash
  2. root@ea80e44b037b:/# htpasswd -c .htpasswd newuser
  3. New password:
  4. Re-type new password:
  5. Adding password for user newuser
  6. root@ea80e44b037b:/# cat .htpasswd
  7. newuser:$apr1$ZVVA17EI$pGLB1MtHbyML.K/ZfWNHD1

https ssl认证

上面可以看到, nginx 编译的时候加载了 http_ssl 模块。在 Dockerfile 中把预先创好的证书文件 server.crt/server.key 放到镜像中

  1. ADD server.crt /etc/ssl/certs/docker-registry
  2. ADD server.key /etc/ssl/private/docker-registry

然后在 nginx.conf 中把 ssl 开关打开,配好证书。

  1. ssl on;
  2. ssl_certificate /etc/ssl/certs/docker-registry;
  3. ssl_certificate_key /etc/ssl/private/docker-registry;

关于https自签名证书的问题,自己可以搜索学习,我是照着 Building private Docker registry with basic authentication 做的,关键是还要保留CA的证书,应该可以从浏览器中导出,我就直接放在镜像里了。

在 boot2docker 下如何处理证书,可以查看 boot2docker的issues #347 。现在重启后,证书目录会重置,现在可以放在脚本中 /var/lib/boot2docker/bootlocal.sh 自动加载,代码如下。

  1. #!/bin/sh
  2. cat /var/lib/boot2docker/ca.pem | sudo tee -a /etc/ssl/certs/ca-certificates.crt

nginx 到 docker registry

  1. 这个如果有 nginx 的知识一看就明白了,不懂的话,直接使用就好了,官方配置 https://github.com/docker/docker-registry/tree/master/contrib/nginx ,主要就是下面一些代码
  2. proxy_set_header Host $http_host; # required for docker client's sake
  3. proxy_set_header X-Real-IP $remote_addr; # pass on real client's IP
  4. proxy_set_header Authorization ""; # see https://github.com/dotcloud/docker-registry/issues/170
  5. proxy_read_timeout 900;
  6. client_max_body_size 0; # disable any limits to avoid HTTP 413 for large image uploads
  7. chunked_transfer_encoding on; # required to avoid HTTP 411: see Issue #1486 (https://github.com/dotcloud/docker/issues/1486)
  8. root /usr/local/nginx/html;
  9. index index.html index.htm;
  10. location / {
  11. auth_basic "Restricted";
  12. auth_basic_user_file docker-registry.htpasswd; # testuser:testpasswd & larrycai:passwd
  13. proxy_pass http://docker-registry;
  14. }
  15. location /v1/_ping {
  16. auth_basic off;
  17. proxy_pass http://docker-registry;
  18. }
  19. location /_ping {
  20. auth_basic off;
  21. proxy_pass http://docker-registry;
  22. }

摘要

在这篇博客中,我们演示了如何用Nginx作为前端服务器来解决Docker 私有registry的安全认证问题,通过它,你应该可以架设一个可以使用的安全的私有regsitry。

  • 用nginx配好basic auth (使用htpasswd)
  • 做好https自签名证书
  • 用nginx配好https服务
  • 把CA根证书导入要访问的docker机器

所有的代码你都可以在 github上的larrycai/nginx-auth-proxy 上找到。

当然现在常用的 pull 命令下载镜像也要认证了,在公司内部会非常讨厌,最好是可以匿名访问。而且一些出错处理也很简单,这些用nginx是比较容易实现的,有机会的话,我会再写博客讲解,如果你有好的方案的话,也请告知。

Docker 可以帮助我们做很多事情,关注我的新浪微博 @larrycaiyu ,我特别愿意探讨软件开发中如何使用docker。

原文出自:https://docker.cn/p/private-docker-registry-with-nginx

【编辑推荐】

  1. CentOS 下安装LEMP服务(Nginx、MariaDB/MySQL和PHP)
  2. 如何在 CentOS 7 上安装 Docker
  3. Docker容器对PaaS来说必不可少吗?
  4. CoreOS 称 Docker 有根本性缺陷,推出自己的容器引擎 Rocket
  5. Docker如何改变云计算安全?

WordPress 条件判断标签及用法大全

在 WordPress 主题和插件开发中,条件判断标签(Conditional Tags)是非常重要的,通过条件判断标签,我们可以判断各种情况,从而使用对应的代码等。例如在顶部导航条中有一个“首页”选项,在首页的时候需要设置成高亮,我们可以在头部导航模板文件(header.php)中使用条件判断标签 is_home() 来判断当前页面是不是首页,然后再输出高亮的 class。

这类的条件判断标签一般会返回一个布尔值,这样我们就可以使用 if 语句判断不同的页面不同的情况而分别使用不同的代码。

为了大家更加方便使用 WordPress 条件判断标签,我爱水煮鱼博客翻译了 WordPress 的官方文档 Conditional Tags,欢迎收藏本文以备用。

所有的条件判断标签

所有的条件判断标签都会判断某个条件是否成立,然后返回 True 或者 False 。此外有些条件判断标签还可以使用一些参数进一步的判断,下面是所有的 WordPress 条件判断标签:

主页面(Main)

is_home()

判断当前页面是否是博客主页面。主页面通常是显示博客内容列表的首页,但是如果你在“后台”->“设置”->“阅读”中设置了静态首页和文章索引页面的话,当访问文章索引页面是返回 True。

首页(Front)

is_front_page()

判断当前页面是否是博客首页。首页和上面的主页面不同,首页可以是文章索引页面,也可以是你在“后台”->“设置”->“阅读”中设置的静态首页。

后台控制面板(Administration Panels)

is_admin()

判断当前页面是否是后台的控制面板(Dashboard)。

文章页面(Single Post)

is_single()

判断当前页面是否是一篇文章或者是附件页面或者自定义文章类型页面。注意,WordPress 中文章(Single)和页面(Page)是不同的概念。这个条件判断标签可以附加参数。

is_single( '17' )

判断当前文章是否是 id 为 17 的文章。

is_single( 'Irish Stew' )

判断当前文章的标题是否是 “Irish Stew”。

is_single( 'beef-stew' )

判断当前文章的别名(Slug)是否为 “beef-stew”。

is_single( array( 17, 'beef-stew', 'Irish Stew' ) )

传递多个参数需要使用数组。上面条件判断标签判断满足 id 为 17 、别名为 beef-stew、标题为 Irish Stew 任意一个条件文章被访问时返回 True。

is_single( array( 17, 19, 1, 11 ) )

判断多个文章的 id,用法同上。

is_single( array( 'beef-stew', 'pea-soup', 'chili' ) )

判断多个文章的别名,用法同上。

is_single( array( 'Beef Stew', 'Pea Soup', 'Chili' ) )

判断多个文章的标题,用法同上。

注意:这个函数对于传递的参数,并无法很明确的判断参数究竟是 id、文章标题或者是文章别名,如果参数为 17,当 id 为 17 的文章会返回 True,当 Slug 为 17 的文章也会返回 True。

置顶文章(Sticky Post)

is_sticky()

WordPress 带有置顶文章的功能,使用这个标签判断是否为置顶文章,需要传递一个参数(通常为文章 id,用法同上)。如果不想传递参数,需要用在主循环(Loop)中,由主循环提供。通常的用法是在主循环输出文章索引列表的时候,使用 is_sticky() 判断当前文章是否为置顶文章,然后在置顶文章的 title 前面输出 “[置顶]” 之类的标志。

文章类型(Post Type)

get_post_type()

严格意义上,这并不是一个条件判断标签,它会返回当前文章注册的文章类型,并且可以通过类似 if ( 'book' == get_post_type() ) ... 来实现判断文章类型的功能。

is_singular()

判断是否满足 is_singleis_pageis_attachment 的任意一个条件,满足返回 True。可以测试所有的文章类型。

post_type_exists()

判断某个文章类型是否被注册了,需要传递一个文章类型参数。它并不是测试某文章是否属于某个文章类型。

is_post_type_hierarchical( $post_type )

如果 $post_type 在注册的时候设置了支持层次( hierarchical support )返回 True。例如:is_post_type_hierarchical( 'book' )

is_post_type_archive()

判断是否在任何的自定义文章类型存档页面(post type archive)。

is_post_type_archive( $post_type )

判断是否在 $post_type 中符合条件的文章类型存档页面,$post_type 可以是一个单一的文章类型或者是一个文章类型数组。提示:如果想要应用文章类型存档功能,需要在注册文章类型的时候,将 has_archive 参数设置为 True。

评论相关(Comments)

is_comments_popup()

判断是否在评论弹出框的窗口中。

comments_open()

判断评论功能是否开启,必须用在主循环中。

pings_open()

判断文章 ping 功能是否开启,必须用在主循环中。

判断页面(Page)

WordPress 中内置的有两种内容形式,一种是文章(Post)另一种是页面(Page),这里要判断的是页面,而不是指你网站的某个网页。

is_page()

判断当前页面是否为“页面”。

is_page( 42 )

判断当前页面是否是一个 ID 为 42 的页面。

is_page( 'About Me And Joe' )

判断当前页面是否是一个标题为 “About Me And Joe” 的页面。

is_page( 'about-me' )

判断当前页面是否是一个别名为 “about-me” 的页面。

is_page( array( 42, 'about-me', 'Aout Me And Joe' ) )

一次包含多种情况的判断,需要使用数组传递,用法同上。

判断内容分页

在文章和页面中,有时候内容很多,在文章中插入 <!--nextpage--> 标签可以将内容分隔开分成不同的页面,并通过对应的函数获取分页的列表。下面的例子,可以判断当前是在第几个页面中,这样你就可以在某个页面中输出一些特别的信息(例如在第一个页面中,输出一个提示)。

例子1:

<?php         
$paged = $wp_query->get( 'page' );

if ( ! $paged || $paged < 2 ) {
    // 这里是不带有分页或者是带有分页页面的第一页
} else {
   // 这里是带有分页的其他页面。
}
?>

例子2:

<?php
$paged = get_query_var( 'page' ) ? get_query_var( 'page' ) : false;
if ( $paged === false ) {
    // 这里是不带有分页或者是带有分页页面的第一页
} else {
   // 这里是带有分页的其他页面。
}
?>

判断子页面(sub-Pages)

WordPress 中的页面(page)是有父子级关系的,判断是否为子页面时,没有内置 is_subpage() 这样的函数,但是你可以使用下面的方法来判断。

方法1:

<?php
global $post;     // 下面代码需要用在主循环中,如果你在循环外使用,需要声明全局变量 $post

if ( is_page() && $post->post_parent ) {
    // 这是一个子页面
} else {
    // 这不是一个子页面
}
?>

建议将下面的方法2加入你的 functions.php 文件中,下面的 is_subpage() 函数的原理与方法1类似,但是可以返回当前页面父页面的 ID 或者是 false。

方法2:

<?php
function is_subpage() {
    global $post;                              // 获取页面的相关信息
    if ( is_page() && $post->post_parent ) {   // 判断是否有父页面
        return $post->post_parent;             // 如果有返回父页面的 ID
    } else {                                   
        return false;                          // 如果没有返回 false
    }
}
?>

如果你经常需要判断子页面,强烈建议使用方法2。

如果需要判断父页面是否为某个特定的页面,可以使用方法3的代码。方法3代码会判断的更加详细,从而更加便于自定义和个性化(例如加一些图片)。

方法3:

<?php
if ( is_page( 'about' ) || '2' == $post->post_parent ) {    
    // 这个页面是“about”页面,或者它的父页面是“about”
    $bannerimg = 'about.jpg';
} elseif ( is_page( 'learning' ) || '56' == $post->post_parent ) {	
    $bannerimg = 'teaching.jpg';
} elseif ( is_page( 'admissions' ) || '15' == $post->post_parent ) { 
    $bannerimg = 'admissions.jpg';
} else { 
    $bannerimg = 'home.jpg'; // 如果都不满足的话,就用这个图片
}
?>

方法4是一个函数可以让你更容易的实现判断,只需要传递参数即可,如果正在访问对应页面,将会返回 True。

方法4:

<?php
function is_tree( $pid ) {      // $pid = 传递的 ID 参数是我们希望判断的页面 ID
    global $post;      

    if ( is_page($pid) )
        return true;            // 当前正在这个页面,所以返回 True

    $anc = get_post_ancestors( $post->ID );
    foreach ( $anc as $ancestor ) {
        if( is_page() && $ancestor == $pid ) {
            return true;
        }
    }

    return false;  // 没有在当前页面,并且这个页面没有子页面
}
?>

可以将这个函数添加进 functions.php 中,调用 is_tree( 'id' ) 就可以判断当前页面是否是指定页面或者是这个页面的子页面。相比较方法3 is_tree( '2' ) 的功能和 is_page( 'about' ) || '2' == $post->post_parent 是一样的。

注意,如果页面乘此多于一级,那么父级页面指的是上一层页面,不是这个页面层次关系最顶层的页面。

判断页面模版(Page Template)

判断当前页面是否由某个页面模版生成的,关于页面模版请看我爱水煮鱼上的:WordPress 教程:自定义页面(Page)的模板样式。

is_page_template()

判断是否使用了一个页面模版。

is_page_template( 'about.php' )

判断应用的页面模版是否是 “about” 这个模板。注意,这个参数与其他参数不同,如果你想判断是否是由某个页面模版声称的,你需要将那个页面模版的文件名填上去,包括后面的 .php 后缀。

判断分类页面(Category)

is_category()

判断当前页面是否为分类目录或者存档(archive)页面。

is_category( '9' )

判断当前分类页面的 ID 是否为 9。

is_category( 'Stinky Cheeses' )

判断当前分类页面的名字是否为“Stinky Cheeses”。

is_category( 'blue-cheese' )

判断当前分类页面的别名是否为“blue-cheese”。

is_category( array( 9, 'blue-cheese', 'Stinky cheeses' ) )

同上,你懂的。

in_category( '5' )

判断当前文章是否属于某个特定分类目录(id 为 5),返回 True。注意,这里是 in 而不是 is,与上面的不同。

in_category( array( 1,2,3 ) )

判断当前文章是否属于某些特定的分类目录。

判断标签页面(Tag)

is_tag()

判断当前页面是否为标签页面。

is_tag( 'mild' )

判断当前标签页面的别名是否为 “mild”。

is_tag( array( 'sharp', 'mild', 'extreme' ) )

判断当前标签页面的别名是否是 “sharp”、“mild”或者“extreme”中的某个。

has_tag()

判断当前文章是否有一个标签,必须用在主循环中。

has_tag( 'mild' )

判断当前文章是否有标签 “mild”。

has_tag( array( 'sharp', 'mild', 'extreme' ) )

判断当前文章是否有数组里的那些标签。

判断自定义分类页面(Taxonomy)

自定义分类页面并非是上面的 category 那种分类页面,而是指 WordPress 分类系统页面。在 WordPress 默认内置了两种分类系统:category 和 tag,同时支持开发者自定义分类系统。

is_tax()

判断当前页面是否为一个分类系统的存档页面。

is_tax( 'flavor' )

判断当前页面是否为一个名为 flavor 自定义分类的存档页面。

is_tax( 'flavor', 'mild' )

判断当前自定义分类 flavor 页面的别名是否为 mild。

is_tax( 'flavor', array( 'sharp', 'mild', 'extreme' ) )

判断当前自定义分类 flavor 页面的页面是否为 sharp、mild、extreme 中的一个。

has_term()

判断当前页面是否带有自定义分类。

has_term( 'green', 'color' )

判断当前页面是否是否带有别名为 green 的自定义分类 color。

has_term( array( 'green', 'orange', 'blue' ), 'color' )

判断当前页面是否是否带有数组中的自定义分类 color。

判断作者页面(Author)

is_author()

判断当前页面是否是一个作者存档页面。

is_author( '4' )

判断当前页面是否为 id 为 4 的作者页面。

is_author( 'Vivian' )

判断当前存档页面是否是 Vivian(Nickname) 的作者存档页面。

is_author( array( 4, 'john-jones', 'Vivian' ) )

判断当前存档页面是否属于 id 为 4,或者名字为 “john-jones”、“Vivian” 的作者存档页面。

is_multi_author()

判断当前博客是否有超过一个作者发表过文章。WordPress 3.2 以上版本可用。

判断是否为日期存档页面(Date Page)

is_date()

判断当前页面是否为任何的按时间存档的页面。

is_year()

判断当前页面是否为按年份存档的页面。

is_month()

判断当前页面是否为按月份存档的页面。

is_day()

判断当前页面是否为按日期存档的页面。

is_time()

判断当前页面是否为按照小时、分钟、秒存档的页面。

is_new_day()

判断当前页面是否为文章日期的新的一天,必须用在主循环中。

判断任意存档页面(Any Archive Page)

is_archive()

判断当前页面是否为一个存档页面,包括:分类、标签、作者页面、日期存档页面等。

判断搜索结果页面(Search Result Page)

is_search()

判断当前页面是否为一个搜索结果页面。

判断是否为 404 页面(404 Not Found Page)

is_404()

判断当前页面是否带有 “HTTP 404:Not Found” 错误。

判断被分页页面(Paged Page)

is_paged()

这里的分页指的是存档页面,如果一个日志或者静态页面的内容通过通过 <!--nextpage--> 拆分成多个页面,这些不能算为 paged page

判断是否为附件页面(Attachment)

is_attachment()

判断当前页面是否为一个附件页面。附件页面通常为一个图片或者是一些其他文件,可以在编辑文章上传文件那里进行设置。

判断单页面、文章页面或者附件页面

is_singular()

只要 is_single()is_page()is_attachment() 返回 True,此函数返回 True。

is_singular( 'book' )

判断当前文章是否属于自定义文章类型(Custom Post Types)“book”。

is_singular( array( 'newspaper', 'book' ) )

判断当前文章是否属于数组中某个自定义文章类型。

判断订阅页面

is_feed()

判断是否在订阅输出的页面。这个判断标签是为插件开发者提供的。

判断引用通告(Trackback)

is_trackback()

判断当前 WordPress 主题是否开启了 Trackback 功能。这个判断标签是为开发者提供的。

判断预览页面

is_preview()

判断一篇文章是否在预览(文章本身处于草稿状态)。

判断是否有摘要

has_excerpt()

判断当前文章是否有摘要内容。

has_excerpt( 42 )

判断文章 ID 为 42 的文章是否有摘要内容。

还可以使用下面代码来实现:

<?php
// 先获取全局变量 $post
global $post;

if ( empty( $post->post_excerpt ) ) {
    // 如果文章没有摘要执行这块代码
} else {
    // 如果文章带有摘要执行这块代码
}
?>

如果你想在文章没有摘要的时候,显示空内容:

<?php if ( ! has_excerpt() ) {
      echo '';
} else { 
      the_excerpt();
}
[/code]

<h3 ><a name="toc-28"></a>判断是否有可用的自定义导航菜单</h3>

[code]
has_nav_menu()

判断一个被注册过的自定义导航菜单是否被指定了一个菜单。

判断是否在主循环中

in_the_loop()

判断是否在主循环内部。对开发者来说很有用。

判断边栏是否已经激活可用

is_active_sidebar()

判断给出的边栏是否激活(正在使用)。如果边栏(用 name、id、number 标志)正在使用,就会返回 True。

判断是否是网站的一部分(对于多站点网站)

is_multisite()

判断当前的站点是否是 WordPress MultiSite 的一部分。

判断是否是主站点(对于多站点网站)

is_main_site()

判断当前站点在整个网络中,是否是主站点。

判断网站的 Admin (对于多站点网站)

is_super_admin()

判断当前用户是否是整个网站中的管理员。

判断插件是否激活

is_plugin_active()

判断某个插件是否激活正在使用。

判断子主题

is_child_theme()

判断当前是否是一个正在使用的子主题。

判断当前主题功能

current_theme_supports()

判断当前主题的功能特性是否存在。

使用条件判断标签的实例

下面给出一些例子,让你明白上面的判断标签如何使用。

文章中的条件判断

下面的例子讲述了当用户访问一篇文章的时候如何使用 is_single() 来显示一些特殊的内容。

if ( is_single() ) {
   echo 'This is just one of many fabulous entries in the ' . single_cat_title() . ' category!';
}

下面的例子介绍了如何在主循环中使用条件判断语句。功能是在首页(index)中显示文章的摘要,而在文章(single)和主页(home)中显示文章的正文内容。

if ( is_home() || is_single() ) {
   the_content();
}
else {
   the_excerpt();
}

同时使用多个条件判断标签

使用常见的 PHP 操作符 就可以使用多个条件判断标签。

// 同时判断两个条件
if ( is_single() || is_page() ) ) {
// 如果当前是一篇文章或者一个页面,就执行这块代码
}

if ( is_archive() && ! is_category( 'nachos' ) ) {
// 如果当前是一个分类的存档页面(除了 nachos 分类),就执行这块代码
}
// 同时判断三个条件
if ( $query->is_main_query() && is_post_type_archive( 'products' ) && ! is_admin() ) {
	// 如果当前是 main query 并且是 products 自定义文章类型的存档页面
	// 同时没有用 admin 账号登陆后台,就执行这块代码
}

if ( is_post_type_archive( 'movies' ) || is_tax( 'genre' ) || is_tax( 'actor' )  ) {
	// 如果当前是 Movies 的自定义文章类型存档
	// 或者是 genre 分类存档页面
	// 或者是 actor 分类存档页面,就执行这块代码
}
来源: http://blog.wpjam.com/article/wordpress-conditional-tags/

Java 字符终端上获取输入三种方式

在Java 字符终端上获取输入有三种方式:

1、java.lang.System.in (目前JDK版本均支持)

2、java.util.Scanner (JDK版本>=1.5)

3、java.io.Console(JDK版本>=1.6),特色:能不回显密码字符

参考:

这里记录Java中从控制台读入信息的几种方式

(1)JDK 1.4(JDK 1.5和JDK 1.6也都兼容这种方法)

package cn.iigrowing.utils.pan.console;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;

public class TestConsole1 {
    public static void main(String[] args) {
        String str = readDataFromConsole("Please input string:");
        System.out.println("The information from console:" + str);
    }

    /**
     * Use InputStreamReader and System.in to read data from console
     *
     * @param prompt
     *
     * @return input string
     */
    private static String readDataFromConsole(String prompt) {
        BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
        String str = null;
        try {
            System.out.print(prompt);
            str = br.readLine();

        } catch (IOException e) {
            e.printStackTrace();
        }
        return str;
    }
}


(2)JDK 1.5(利用Scanner进行读取)

-----------------------------------------------
package cn.iigrowing.utils.pan.console;

import java.util.Scanner;

public class TestConsole2 {
    public static void main(String[] args) {
        String str = readDataFromConsole("Please input string:");
        System.out.println("The information from console:" + str);
    }

    /**
     * Use java.util.Scanner to read data from console
     *
     * @param prompt
     *
     * @return input string
     */
    private static String readDataFromConsole(String prompt) {
        Scanner scanner = new Scanner(System.in);
        System.out.print(prompt);
        return scanner.nextLine();
    }
}
-----------------------------------------------

Scanner还可以很方便的扫描文件,读取里面的信息并转换成你要的类型,比如对“2 2.2 3.3 3.33 4.5 done”这样的数据求和,见如下代码:

-----------------------------
package cn.iigrowing.utils.pan.console;

import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.util.Scanner;

public class TestConsole3 {

    public static void main(String[] args) throws IOException {
        FileWriter fw = new FileWriter("num.txt");
        fw.write("2 2.2 3.3 3.33 4.5 done");
        fw.close();

        System.out.println("Sum is " + scanFileForSum("num.txt"));
    }

    public static double scanFileForSum(String fileName) throws IOException {
        double sum = 0.0;
        FileReader fr = null;
        try {
            fr = new FileReader(fileName);
            Scanner scanner = new Scanner(fr);

            while (scanner.hasNext()) {
                if (scanner.hasNextDouble()) {
                    sum = sum + scanner.nextDouble();

                } else {
                    String str = scanner.next();

                    if (str.equals("done")) {
                        break;
                    } else {
                        throw new RuntimeException("File Format is wrong!");
                    }

                }
            }

        } catch (FileNotFoundException e) {
            throw new RuntimeException("File " + fileName + " not found!");
        } finally {
            if (fr != null)
                fr.close();
        }
        return sum;
    }
}
-----------------------------

 

(3)JDK 1.6(利用java.io.Console进行读取)

JDK6中提供了java.io.Console类专用来访问基于字符的控制台设备.
你的程序如果要与Windows下的cmd或者Linux下的Terminal交互,就可以用Console类代劳.(类似System.in和System.out)
但我们不总是能得到可用的Console, 一个JVM是否有可用的Console依赖于底层平台和JVM如何被调用.
如果JVM是在交互式命令行(比如Windows的cmd)中启动的,并且输入输出没有重定向到另外的地方,那么就可以得到一个可用的Console实例。

在使用 IDE 的情况下,是无法获取到Console实例的,原因在于在 IDE 的环境下,重新定向了标准输入和输出流,也是就是将系统控制台上的输入输出重定向到了 IDE 的控制台中

----------------------
package cn.iigrowing.utils.pan.console;

import java.io.Console;

/**
 * 建议打成 可以运行的jar进行运行   java -jar pan.xxxx.jar
 * @author iigadmin
 *
 */
public class TestConsole5 {
    public static void main(String[] args) {
        String str = readDataFromConsole("Please input string:");
        System.out.println("The information from console:" + str);
    }

    /**
     * Use java.io.console to read data from console
     *
     * @param prompt
     *
     * @return input string
     */
    private static String readDataFromConsole(String prompt) {
        Console console = System.console();
        if (console == null) {
            throw new IllegalStateException("Console is not available!");
        }
        return console.readLine(prompt);
    }
}
----------------------

 

Console类还有个特色就是,专门对密码(输入无回显)等安全字符,进行了处理。专门提供 readPassword()方法,具体应用见如下代码:

-------
package cn.iigrowing.utils.pan.console;

import java.io.Console;

public class TestConsole6 {

    public static void main(String[] args) {
        Console console = System.console();
        if (console == null) {
            throw new IllegalStateException("Console is not available!");
        }

        while (true) {
            String username = console.readLine("Username: ");
            char[] password = console.readPassword("Password: ");

            if (username.equals("Chris") && String.valueOf(password).equals("GoHead")) {
                console.printf("Welcome to Java Application %1$s.\n", username);
                // 使用后应立即将数组清空,以减少其在内存中占用的时间,增强安全性
                password = null;
                System.exit(-1);
            } else {
                console.printf("Invalid username or password.\n");
            }
        }
    }
}
-------

 

xpath路径表达式笔记

简单说,xpath就是选择XML文件中节点的方法。

所谓节点(node),就是XML文件的最小构成单位,一共分成7种。

- element(元素节点)
- attribute(属性节点)
- text (文本节点)
- namespace (名称空间节点)
- processing-instruction (处理命令节点)
- comment (注释节点)
- root (根节点)

xpath可以用来选择这7种节点。不过,下面的笔记只涉及最常用的第一种element(元素节点),因此可以将下文中的节点和元素视为同义词。一、xpath表达式的基本格式

xpath通过"路径表达式"(Path Expression)来选择节点。在形式上,"路径表达式"与传统的文件系统非常类似。

# 斜杠(/)作为路径内部的分割符。

# 同一个节点有绝对路径和相对路径两种写法。

# 绝对路径(absolute path)必须用"/"起首,后面紧跟根节点,比如/step/step/...。

# 相对路径(relative path)则是除了绝对路径以外的其他写法,比如 step/step,也就是不使用"/"起首。

# "."表示当前节点。

# ".."表示当前节点的父节点

二、选择节点的基本规则

- nodename(节点名称):表示选择该节点的所有子节点

- "/":表示选择根节点

- "//":表示选择任意位置的某个节点

- "@": 表示选择某个属性

三、选择节点的实例

先看一个XML实例文档。

<?xml version="1.0" encoding="ISO-8859-1"?>

<bookstore>

<book>
<title lang="eng">Harry Potter</title>
<price>29.99</price>
</book>

<book>
<title lang="eng">Learning XML</title>
<price>39.95</price>
</book>

</bookstore>

[例1]

bookstore :选取 bookstore 元素的所有子节点。

[例2]

/bookstore :选取根节点bookstore,这是绝对路径写法。

[例3]

bookstore/book :选取所有属于 bookstore 的子元素的 book元素,这是相对路径写法。

[例4]

//book :选择所有 book 子元素,而不管它们在文档中的位置。

[例5]

bookstore//book :选择所有属于 bookstore 元素的后代的 book 元素,而不管它们位于 bookstore 之下的什么位置。

[例6]

//@lang :选取所有名为 lang 的属性。

四、xpath的谓语条件(Predicate)

所谓"谓语条件",就是对路径表达式的附加条件。

所有的条件,都写在方括号"[]"中,表示对节点进行进一步的筛选。

[例7]

/bookstore/book[1] :表示选择bookstore的第一个book子元素。

[例8]

/bookstore/book[last()] :表示选择bookstore的最后一个book子元素。

[例9]

/bookstore/book[last()-1] :表示选择bookstore的倒数第二个book子元素。

[例10]

/bookstore/book[position()<3] :表示选择bookstore的前两个book子元素。

[例11]

//title[@lang] :表示选择所有具有lang属性的title节点。

[例12]

//title[@lang='eng'] :表示选择所有lang属性的值等于"eng"的title节点。

[例13]

/bookstore/book[price] :表示选择bookstore的book子元素,且被选中的book元素必须带有price子元素。

[例14]

/bookstore/book[price>35.00] :表示选择bookstore的book子元素,且被选中的book元素的price子元素值必须大于35。

[例15]

/bookstore/book[price>35.00]/title :表示在例14结果集中,选择title子元素。

[例16]

/bookstore/book/price[.>35.00] :表示选择值大于35的"/bookstore/book"的price子元素。

五、通配符

# "*"表示匹配任何元素节点。

# "@*"表示匹配任何属性值。

# node()表示匹配任何类型的节点。

[例17]//* :选择文档中的所有元素节点。

[例18]

/*/* :表示选择所有第二层的元素节点。

[例19]

/bookstore/* :表示选择bookstore的所有元素子节点。

[例20]

//title[@*] :表示选择所有带有属性的title元素。

六、选择多个路径

用"|"选择多个并列的路径。

[例21]

//book/title | //book/price :表示同时选择book元素的title子元素和price子元素。

 

 

Xpath学习笔记

1.       /AAA:选择根元素AAA

2.       //BBB:所有BBB元素

3.       /AAA/CCC/DDD/*:选择/AAA/CCC/DDD/下所有元素

4.       /*/*/*/BBB:选择有3个祖先元素的BBB元素

5.       //*:选择所有元素

6.       /AAA/BBB[1]:选择AAA的第一个BBB子元素

7.       //@ID:选择所有的ID属性;//BBB[@ID]:选择有ID属性的BBB元素;//BBB[@*]:选择有任意属性的BBB元素;//BBB[not (@*)]:选择没有属性的BBB元素

8.       //BBB[normalize-space(@name)=’bbb’] :选择含有name且值(用mormalize-space去掉前后空格)为‘bbb’的BBB元素

9.       //*[count(BBB)=2]:选择含有2个BBB子元素的元素;//*[count(*)=2];

10.    Name():返回元素名称;start-with():第一个参数是以第二个参数为开始的为TRUE;contains():第一个参数包含第二个参数时为true;例:

1)         //*[name()=’BBB’]:名称为BBB的元素

2)         //*[starts-with(name(),’B’)]:所有名称为B起始的元素

3)         //*[contains(name(),’C’)]:所有名称包含C的元素

11.    |:多个路径合并在一起。例://CCC|//BBB:选择所有的CCC和BBB元素;

12.    Child轴:

1)         /AAA:等价于/child::AAA

2)         /AAA/BBB:等价于/child::AAA/child::BBB等价于/child:AAA/BBB

13.    Descendant后代轴:不会包含属性和命名空间节点
/descendant::*:选择文档根元素的所有后代,即所有的元素被选择

/AAA/BBB/descendant::*:选择/AAA/BBB的所有后代元素

//CCC/descendant::*:选择在祖先元素中有CCC的所有元素

//CCC/descendant::DD:选择所有以CCC为祖先元素的DDD元素

14.    Parent轴:包含上下文节点的父节点。

//DDD/parent::*:选择DDD元素的所有父节点

15.    Ancestor轴:包含上下节点的祖先节点,由父节点以及父节点的父节点等构成,所以总是包含根节点,除非上下文节点就是根节点本身。

/AAA/BBB/DDD/CCC/EEE/ancestor::*:选择一个绝对路径上的所有节点

//FFF/ancestor::*:选择FFF元素的祖先节点

16.    Following-sibling轴:上下文节点之后的所有兄弟节点

/AAA/BBB/following-sibling::*

17.    Preceding-sibling轴:包含上下文节点之前的所有兄弟节点

/AAA/XXX/preceding-sibling::*:

18.    Following轴:包含同一文档中按文档顺序位于上下文节点之后的所有节点,除了祖先节点,属性节点和命名空间节点

/AAA/XXX/following::*

19.    preceding 轴(axis)包含同一文档中按文档顺序位于上下文节点之前的所有节点, 除了祖先节点,属性节点和命名空间节点,如/AAA/XXX/preceding::*

20.    descendant-or-self轴:包含上下文节点本身和该节点的后代节点,如:/AAA/XXX/descendant-or-self::*

21.    ancestor-or-self轴:包含上下文节点本身和该节点的祖先节点

22.    ancestor, descendant, following, preceding 和self轴(axis)分割了XML文档(忽略属性节点和命名空间节点), 不能交迭, 而一起使用则包含所有节点,例://GGG/ancestor::*

23.    div运算符做浮点除法运算, mod运算符做求余运算, floor 函数返回不大于参数的最大整数(趋近于正无穷), ceiling 返回不小于参数的最小整数(趋近于负无穷) ,例:

1)         //BBB[position() mod 2 = 0 ];

2)         //CCC[ position() = floor(last() div 2 + 0.5) or position() = ceiling(last() div 2 + 0.5) ]

Selenium WebDriver 中鼠标和键盘事件分析及扩展

在使用 Selenium WebDriver 做自动化测试的时候,会经常模拟鼠标和键盘的一些行为。比如使用鼠标单击、双击、右击、拖拽等动作;或者键盘输入、快捷键使用、组合键使用等模拟键盘的操作。在 WebDeriver 中,有一个专门的类来负责实现这些测试场景,那就是 Actions 类,在使用该类的过程中会配合使用到 Keys 枚举以及 Mouse、 Keyboard、CompositeAction 等类。

其次,在实际测试过程中,可能会遇到某些按键没办法使用 Actions、Keys 等类来实现的情况。 比如通过使用 Alt+PrtSc 组合键来实现截取屏幕当前活动窗口的图像,在 Keys 枚举中,因为没有枚举出 PrtSc 键,所以没办法通过 Action 的 KeyDown(Keys) 来模拟按下这个动作。

再次是在自动化测试中,可能会遇到一些附件、文件上传的场景,或者是多文件上传,这些在 Selenium2.0 之后,可以直接使用 WebElement 类的 sendKeys() 方法来实现。

下面就分别介绍这些情况的具体使用。

鼠标点击操作

鼠标点击事件有以下几种类型:

清单 1. 鼠标左键点击
Actions action = new Actions(driver);action.click();// 鼠标左键在当前停留的位置做单击操作 
action.click(driver.findElement(By.name(element)))// 鼠标左键点击指定的元素
清单 2. 鼠标右键点击
Actions action = new Actions(driver); 
 action.contextClick();// 鼠标右键在当前停留的位置做单击操作 
action.contextClick(driver.findElement(By.name(element)))// 鼠标右键点击指定的元素
清单 3. 鼠标双击操作
Actions action = new Actions(driver); 
 action.doubleClick();// 鼠标在当前停留的位置做双击操作 
action.doubleClick(driver.findElement(By.name(element)))// 鼠标双击指定的元素
清单 4. 鼠标拖拽动作
Actions action = new Actions(driver); 
// 鼠标拖拽动作,将 source 元素拖放到 target 元素的位置。
 action.dragAndDrop(source,target);
// 鼠标拖拽动作,将 source 元素拖放到 (xOffset, yOffset) 位置,其中 xOffset 为横坐标,yOffset 为纵坐标。
action.dragAndDrop(source,xOffset,yOffset);

在这个拖拽的过程中,已经使用到了鼠标的组合动作,首先是鼠标点击并按住 (click-and-hold) source 元素,然后执行鼠标移动动作 (mouse move),移动到 target 元素位置或者是 (xOffset, yOffset) 位置,再执行鼠标的释放动作 (mouse release)。所以上面的方法也可以拆分成以下的几个执行动作来完成:

action.clickAndHold(source).moveToElement(target).perform(); 
 action.release();
清单 5. 鼠标悬停操作
Actions action = new Actions(driver); 
 action.clickAndHold();// 鼠标悬停在当前位置,既点击并且不释放
 action.clickAndHold(onElement);// 鼠标悬停在 onElement 元素的位置

action.clickAndHold(onElement) 这个方法实际上是执行了两个动作,首先是鼠标移动到元素 onElement,然后再 clickAndHold, 所以这个方法也可以写成 action.moveToElement(onElement).clickAndHold()。

清单 6. 鼠标移动操作
Actions action = new Actions(driver); 
 action.moveToElement(toElement);// 将鼠标移到 toElement 元素中点
// 将鼠标移到元素 toElement 的 (xOffset, yOffset) 位置,
//这里的 (xOffset, yOffset) 是以元素 toElement 的左上角为 (0,0) 开始的 (x, y) 坐标轴。
 action.moveToElement(toElement,xOffset,yOffset)
// 以鼠标当前位置或者 (0,0) 为中心开始移动到 (xOffset, yOffset) 坐标轴
 action.moveByOffset(xOffset,yOffset);

action.moveByOffset(xOffset,yOffset) 这里需要注意,如果 xOffset 为负数,表示横坐标向左移动,yOffset 为负数表示纵坐标向上移动。而且如果这两个值大于当前屏幕的大小,鼠标只能移到屏幕最边界的位置同时抛出 MoveTargetOutOfBoundsExecption 的异常。

鼠标移动操作在测试环境中比较常用到的场景是需要获取某元素的 flyover/tips,实际应用中很多 flyover 只有当鼠标移动到这个元素之后才出现,所以这个时候通过执行 moveToElement(toElement) 操作,就能达到预期的效果。但是根据我个人的经验,这个方法对于某些特定产品的图标,图像之类的 flyover/tips 也不起作用,虽然在手动操作的时候移动鼠标到这些图标上面可以出现 flyover, 但是当使用 WebDriver 来模拟这一移动操作时,虽然方法成功执行了,但是 flyover 却出不来。所以在实际应用中,还需要对具体的产品页面做相应的处理。

清单 7. 鼠标释放操
Actions action = new Actions(driver); 
 action.release();// 释放鼠标

键盘模拟操作

对于键盘的模拟操作,Actions 类中有提供 keyUp(theKey)、keyDown(theKey)、sendKeys(keysToSend) 等方法来实现。键盘的操作有普通键盘和修饰键盘(Modifier Keys, 下面的章节将讲到修饰键的概念)两种 :

1. 对于普通键盘,使用 sendKeys(keysToSend) 就可以实现,比如按键 TAB、Backspace 等。

清单 8. 普通键盘模拟 sendKeys(keysToSend)
Actions action = new Actions(driver); 
 action.sendKeys(Keys.TAB);// 模拟按下并释放 TAB 键
 action.sendKeys(Keys.SPACE);// 模拟按下并释放空格键
/***
针对某个元素发出某个键盘的按键操作,或者是输入操作,
比如在 input 框中输入某个字符也可以使用这个方法。这个方法也可以拆分成:
action.click(element).sendKeys(keysToSend)。
*/
 action.sendKeys(element,keysToSend);

注意除了 Actions 类有 sendKeys(keysToSend)方法外,WebElement 类也有一个 sendKeys(keysToSend)方法,这两个方法对于一般的输入操作基本上相同,不同点在于以下几点:

  • Actions 中的 sendKeys(keysToSend) 对于修饰键 (Modifier Keys) 的调用并不会释放,也就是说当调用 actions.sendKeys(Keys.ALT); actions.sendKeys(Keys.CONTROL); action.sendKeys(Keys.SHIFT); 的时候,相当于调用 actions.keyDown(keysToSend),而如果在现实的应用中想要模拟按下并且释放这些修饰键,应该再调用 action.sendKeys(keys.NULL) 来完成这个动作。
  • 其次就是当 Actions 的 sendKeys(keysToSend) 执行完之后,焦点就不在当前元素了。所以我们可以使用 sendKeys(Keys.TAB) 来切换元素的焦点,从而达到选择元素的作用,这个最常用到的场景就是在用户名和密码的输入过程中。
  • 第三点,在 WebDriver 中,我们可以使用 WebElement 类的 sendKeys(keysToSend) 来上传附件,比如 element.sendKeys(“C:\\test\\uploadfile\\test.jpg”); 这个操作将 test.jpg 上传到服务器,但是使用:
Actions action = New Actions(driver); 
 action.sendKeys(element,“C:\\test\\upload\\test.jpg”); 
action.click(element).sendKeys(“C:\\test\\upload\\test.jpg”);

这种方式是上传不成功的,虽然 WebDriver 在执行这条语句的时候不会出错,但是实际上并没有将文件上传。所以要上传文件,还是应该使用前面一种方式。

2.对于修饰键(Modifier keys),一般都是跟普通键组合使用的。比如 Ctrl+a、Alt+F4、 Shift+Ctrl+F 等等。

  • 这里先解释一下修饰键的概念,修饰键是键盘上的一个或者一组特别的键,当它与一般按键同时使用的时候,用来临时改变一般键盘的普通行为。对于单独按下修饰键本身一般不会触发任何键盘事件。在个人计算机上的键盘上,有以下几个修饰键:Shift、Ctrl、Alt(Option)、AltGr、Windows logo、Command、FN(Function)。但是在 WebDriver 中,一般的修饰键指前面三个。你可以点击下面的 Wiki 链接去了解更多有关修饰键的信息,Modifier key。
  • 回到上面的话题,在 WebDriver 中对于修饰键的使用需要用到 KeyDown(theKey)、keyUp(theKey) 方法来操作。
清单 9. 修饰键方法 KeyDown(theKey)、keyUp(theKey)
Actions action = new Actions(driver); 
 action.keyDown(Keys.CONTROL);// 按下 Ctrl 键
 action.keyDown(Keys.SHIFT);// 按下 Shift 键
 action.keyDown(Key.ALT);// 按下 Alt 键
 action.keyUp(Keys.CONTROL);// 释放 Ctrl 键
 action.keyUp(Keys.SHIFT);// 释放 Shift 键
 action.keyUp(Keys.ALT);// 释放 Alt 键

所以要通过 Alt+F4 来关闭当前的活动窗口,可以通过下面语句来实现:action.keyDown(Keys.ALT).keyDown(Keys.F4).keyUp(Keys.ALT).perform();

而如果是对于像键盘上面的字母键 a,b,c,d... 等的组合使用,可以通过以下语句实现 :action.keyDown(Keys.CONTROL).sednKeys(“a”).perform();

在 WebDriver API 中,KeyDown(Keys theKey)、KeyUp(Keys theKey) 方法的参数只能是修饰键:Keys.SHIFT、Keys.ALT、Keys.CONTROL, 否者将抛出 IllegalArgumentException 异常。 其次对于 action.keyDown(theKey) 方法的调用,如果没有显示的调用 action.keyUp(theKey) 或者 action.sendKeys(Keys.NULL) 来释放的话,这个按键将一直保持按住状态。

使用 Robot 类来操作 Keys 没有枚举出来的按键操作

1.在 WebDriver 中,Keys 枚举出了键盘上大多数的非字母类按键,从 F1 到 F10,NUMPAD0 到 NUMPAD9、ALT\TAB\CTRL\SHIFT 等等,你可以通过以下链接查看 Keys 枚举出来的所有按键,Enum Keys。 但是并没有列出键盘上的所有按键,比如字母键 a、b、c、d … z,一些符号键比如:‘ {}\[] ’、‘ \ ’、‘。’、‘ ? ’、‘:’、‘ + ’、‘ - ’、‘ = ’、、‘“”’,还有一些不常用到的功能键如 PrtSc、ScrLk/NmLk。对于字母键和符号键,前面我们已经提到可以直接使用 sendKeys(“a”),sendKeys(“/”) 的方式来触发这些键盘事件。而对于一些功能组合键,如 Fn + NmLk 来关闭或者打开数字键,或者 Alt+PrtSC 来抓取当前屏幕的活动窗口并保存到图片,通过 WebDriver 的 Keys 是没办法操作的。 这个时候我们就需要用到 Java 的 Robot 类来实现对这类组合键的操作了。

2.下面就以对 Alt+PrtSc 为例介绍一下 Robot 对键盘的操作。如代码清单 10。

清单 10. 通过 Robot 发出组合键动作
/** 
 * 
 * @Description: 这个方法用来模拟发送组合键 Alt + PrtSc, 当组合键盘事件执行之后,屏幕上的活动窗口
 * 就被截取并且存储在剪切板了。 接下来就是通过读取剪切板数据转换成 Image 图像对象并保存到本地。
 * @param filename : 要保存的图像的名称
 */ 
 public static void sendComposeKeys(String fileName) throws Exception { 
		 // 构建 Robot 对象,用来操作键盘
		 Robot robot = new Robot(); 
		 // 模拟按下键盘动作,这里通过使用 KeyEvent 类来获取对应键盘(ALT)的虚拟键码
 robot.keyPress(java.awt.event.KeyEvent.VK_ALT); 
		 // 按下 PrtSC 键
		 robot.keyPress(java.awt.event.KeyEvent.VK_PRINTSCREEN); 
		 // 释放键盘动作,当这个动作完成之后,模拟组合键 Alt + PrtSC 的过程就已经完成,
//此时屏幕活动窗口就一被截取并存入到剪切板
		 robot.keyRelease(java.awt.event.KeyEvent.VK_ALT); 
		 // 获取系统剪切板实例
 Clipboard sysc = Toolkit.getDefaultToolkit().getSystemClipboard(); 
		 // 通过 getContents() 方法就可以将剪切板内容获取并存入 Transferable 对象中
		 Transferable data = sysc.getContents(null); 
		 if (data != null) { 
/***
判断从剪切板获取的对象内容是否为 Java Image 类, 如果是将直接转化为 Image 对象。
到此为止,我们就从发出组合键到抓取活动窗口,再读取剪切板并存入 Image 对象的过程
就完成了,接下来要做的就是需要将 Image 对象保存到本地。
*/
			 if (data.isDataFlavorSupported(DataFlavor.imageFlavor)) { 
				 Image image = (Image) data 
						 .getTransferData(DataFlavor.imageFlavor); 
				 writeImageToFile(image, fileName); 
			 } 
		 } 
	 }

Robot 类对键盘的处理是通过 keyPress(int keycode)、keyRelease(int keycode) 方法来实现的,其中他们需要的参数是键盘按键对应的虚拟键码,虚拟键码的值可以通过 KeyEvent 类来获取。在 Java API 中对于虚拟键码的解释如下: 虚拟键码用于报告按下了键盘上的哪个键,而不是一次或多次键击组合生成的字符(如 "A" 是由 shift + "a" 生成的)。 例如,按下 Shift 键会生成 keyCode 为 VK_SHIFT 的 KEY_PRESSED 事件,而按下 'a' 键将生成 keyCode 为 VK_A 的 KEY_PRESSED 事件。释放 'a' 键后,会激发 keyCode 为 VK_A 的 KEY_RELEASED 事件。另外,还会生成一个 keyChar 值为 'A' 的 KEY_TYPED 事件。 按下和释放键盘上的键会导致(依次)生成以下键事件:

KEY_PRESSED

KEY_TYPED(只在可生成有效 Unicode 字符时产生。)

KEY_RELEASED

所以当测试中需要用到按下键盘 Alt+PrtSc 键的时候,只需要执行代码清单 10 中两个 keyPress() 和一个 keyRelease() 方法即可。

3.当这两个按键执行结束之后,屏幕上面的活动窗口已经保存到剪切板中。如果需要将其保存本地图片,只需要从剪切板读取并通过 JPEGImageEncoder 类或者 ImageIO 类将其写入本地即可。

清单 11. 使用 JPEGImageEncoder 将 Image 对象保存到本地
/** 
 * 
 * @Description: 这个方法用来将 Image 对象保存到本地,主要是通过 JPEGImageEncoder 类来实现图像的
 * 保存
 * @param image : 要保存的 Image 对象
 * @param filename : 保存图片的文件名称
 */ 
 public static void writeImageToFile(Image image, String fileName) { 
		 try { 
			 // 获取 Image 对象的宽度和高度, 这里的参数为 null 表示不需要通知任何观察者int width = image.getWidth(null);int height = image.getHeight(null); 
			 BufferedImage bi = new BufferedImage(width, height, 
					 BufferedImage.TYPE_INT_RGB); 
 // 通过 BufferedImage 绘制图像并保存在其对象中
			 bi.getGraphics().drawImage(image, 0, 0, null); 
			 // 构建图像名称及保存路径
			 String name = Const.DIRECTORY + fileName + Const.FORMAT; 
			 File dir = new File(Const.DIRECTORY); 
			 if (!dir.exists()) { 
				 dir.mkdir(); 
			 } 
			 FileOutputStream ut = new FileOutputStream(name); 
			 @SuppressWarnings("restriction") 
			 JPEGImageEncoder encoder = JPEGCodec.createJPEGEncoder(out); 
 encoder.encode(bi); 
			 out.flush(); 
 out.close(); 
		 } catch (Exception e) { 
			 e.printStackTrace(); 
		 } 
	 }

代码清单 11 是通过 JPEGImageEncoder 类将 Image 对象写到本地文件流,注意 Image 对象是在代码清单 10 中的如下语句获取到的:

Clipboard sysc = Toolkit.getDefaultToolkit().getSystemClipboard(); 
		 Transferable data = sysc.getContents(null); 
		 if (data != null) { 
			 if (data.isDataFlavorSupported(DataFlavor.imageFlavor)) { 
				 Image image = (Image) data 
						 .getTransferData(DataFlavor.imageFlavor); 
				 writeImageToFile(image, fileName); 
			 } 
		 }
清单 12. 使用 ImageIO 将 Image 对象保存到本地
/** 
 * 
 * @Description: 通过使用 ImageIO 类来保存 Image 对象为本地图片
 * @param image : 需要保存的 Image 对象
 * @param filename : 文件名
 */ 
 public static void saveImage(Image image, String fileName) throws Exception { 
	 // 获取 Image 对象的高度和宽度
	 int width = image.getWidth(null); 
	 int height = image.getHeight(null); 
	 BufferedImage bi = new BufferedImage(width, height, 
			 BufferedImage.TYPE_INT_RGB); 
	 Graphics g = bi.getGraphics(); 
     //通过 BufferedImage 绘制图像并保存在其对象中
	 g.drawImage(image, 0, 0, width, height, null); 
	 g.dispose(); 
	 File f = new File(fileName); 
	 // 通过 ImageIO 将图像写入到文件
	 ImageIO.write(bi, "jpg", f); 
	 }

使用 sendKeys(keysToSend) 批量上传文件

在 Selenium2.0 之前,要上传文件是比较麻烦的一件事件,因为点击 Upload File 控件会弹出 Windows 窗口以提供用户选择文件,但是 Window 窗口已经是浏览器之外的组件,所以 Selenium 本身没办法控制, 而必须使用 Java Robot 类来模拟键盘去操作剪切板实现上传功能,而且及其不稳定。 在 Selenium 2.0 之后,WebDriver 解决了这个问题。前面已经谈到过,直接使用 WebElement 类的 sendKeys(keysToSend) 方法就可以实现文件上传了。但是如果想批量上传文件,使用 element.sendKeys(“C:\\test\\upload\\test1.txt”, “C:\\test\\upload\\test2.txt”...) 方法也是不行的,它能通过执行,但是实际上没有上传成功。这时可以通过循环的方式来实现文件的批量上传,代码清单 13 是我在百度云上面批量上传文件的测试。

清单 13. 批量上传文件
/** 
 * 
 * @Description: 在百度云上测试文件批量上传功能,主要是通过循环的方式去做单一
 * 的上传动作 , 登陆过程已经去掉
 */ 
 @Test 
 public void test_mutilUploadFile() throws Exception { 
 System.out.println("upload start"); 
		 // 获取上传控件元素
 WebElement uploadButton = driver.findElement(By.name("html5uploader")); 
 // 构建上传文件路径,将需要上传的文件添加到 CharSequence 数组
 CharSequence[] files = new CharSequence[5]; 
		 files[0] = "C:\\test\\test1.txt"; 
		 files[1] = "C:\\test\\test2.txt"; 
		 files[2] = "C:\\test\\test3.txt"; 
		 files[3] = "C:\\test\\test4.txt"; 
		 files[4] = "C:\\test\\test5.txt"; 
		 // 循环列出每支需要上传的文件路径,做单一上传动作
		 for(CharSequence file: files){ 
 uploadButton.sendKeys(file); 
		 } 
		 Thread.sleep(2000); 
 System.out.println("upload end"); 
	 }

当执行结束后,效果如图 1。

图 1. 批量上传文件

批量上传文件

结束语

在 Selenium WebDriver 中,有了 Actions 类和 Keys 枚举对键盘和鼠标的操作已经做的非常到位,再结合 Java 本身 Robot、KeyEvent 等类的使用,基本上可以满足工作中遇到的对鼠标键盘操作的应用了。

其次要注意的地方是 WebDriver 对浏览器的支持问题,Selenium WebDriver 支持的浏览器非常广泛,从 IE、Firefox、Chrome 到 Safari 等浏览器, WebDriver 都有相对应的实现:InterntExplorerDriver、FirefoxDriver、ChromeDriver、SafariDriver、AndroidDriver、 IPhoneDriver、HtmlUnitDriver 等。根据个人的经验,Firefox 以及 Chrome 浏览器对 WebDriver 的支持最好了,Firefox 搭上 Firebug 以及 Firepath, 在写脚本的过程中非常方便,而 ChromeDriver 是 Google 公司自己支持与维护的项目。HtmlUnitDriver 速度最快,一个纯 Java 实现的浏览器。IE 比较慢,而且对于 Xpath 等支持不是很好。更多关于 Selenium WebDriver 的知识,大家可以从下面的链接去访问 Selenium 官方文档。

http://www.ibm.com/developerworks/cn/java/j-lo-keyboard/index.html