自动更新@version $Id$版本号信息（subversion svn:keywords）

在一些开源项目的文件注释中，经常会见到一串类似“@version $Id: Result.php 20096 2010-01-06 02:05:09Z bkarwin $”的字符信息。它描述的是该文件当前的综合版本信息，方便我们了解更多该文件的历史信息。
以上字符串中，前面的“@version”为注释文档（如：JAVADoc,PHPDoc）的版本字段，后面的则是SVN中的版本信息。那么，这些信息是如何更新的呢？不至于手工一个个编辑吧，那每次更新前还要查一下修订号多麻烦。

答案当然不是，大多的版本控制软件都提供了该功能。在用户提交代码是，版本控制软件自动更新你的标注。在subversion中提供了一个svn:keywords的命令，通过该命令可以更新代码中标注的关键字，以包含最新的相关信息（如：修订号、修改日期等)。

命令格式:

svn propset svn:keywords "Id" prosetfile

svn:keywords参数
Id: 这是一种综合的格式，如"$Id: ProductController.php 13308 2011-09-01 09:01:02Z wbq $"
LastChangedDate: 最后被修改的时间，这个属性也可以缩写为Date。
LastChangedBy: 最后修改该源代码文件的用户名，这个属性也可以被缩写为Author。
LastChangedRevision: 最后修订的版本号，这个属性也可以被缩写为Revision或者Rev。
HeadURL: 该源代码文件所位于的 Repository 上的绝对 URL 地址，这个属性也可以被缩写为URL。

 

下面是一个实例

 

1、config.php的原始文件

<?php
/**
 * DF3C 前台公用文件
 * ==============================================
 * 版权所有 2010-2011 http://www.df3c.com
 * ----------------------------------------------
 * 这不是一个自由软件，未经授权，不允许任何个人或组织传播和使用。
 * ==============================================
 * @date: 2011-10-7
 * @author: wumh
 * @version: 
*/

// database host
$db_host   = "localhost:3306";

// database name
$db_name   = "shop";

// database username
$db_user   = "root";

// database password
$db_pass   = "";

 

2、设置keywords属性
svn propset svn:keywords "Id" config.php

注：如果使用的是TortoiseSVN这样的图形界面工具，为“右击文件->properties->new->svn:keywords”,然后输入参数Id或LastChangedDate、Author等，设置多个关键字用换行分开。

Subversion只会对明确指定关键字进行更新，未指定的关键字不会更新到文件中。

3、在config.php中加入关键字

<?php
/**
 * DF3C 前台公用文件
 * ==============================================
 * 版权所有 2010-2011 http://www.df3c.com
 * ----------------------------------------------
 * 这不是一个自由软件，未经授权，不允许任何个人或组织传播和使用。
 * ==============================================
 * @date: 2011-10-7
 * @author: wumh
 * @version: $Id$
*/

// database host
$db_host   = "localhost:3306";

// database name
$db_name   = "shop";

// database username
$db_user   = "root";

// database password
$db_pass   = "";

 在@version: 后面增加“$Id$”，也可以是“$LastChangedDate$”、“$Author$”等。

 

4、提交更新

<?php
/**
 * DF3C 前台公用文件
 * ==============================================
 * 版权所有 2010-2011 http://www.df3c.com
 * ----------------------------------------------
 * 这不是一个自由软件，未经授权，不允许任何个人或组织传播和使用。
 * ==============================================
 * @date: 2011-10-7
 * @author: wumh
 * @version: $Id: index.php 21 2011-10-07 03:53:20Z wumh $
*/

// database host
$db_host   = "localhost:3306";

// database name
$db_name   = "shop";

// database username
$db_user   = "root";

// database password
$db_pass   = "";

 在subversion中提交修改后，就会变为类似上面你所看到的内容。

 

相关应用

 

在web服务器中，为了提高性能，大多时候都会启用缓存策略。而缓存的机制多是围绕url实现，这样常常会导致不清空缓存不能换取最新文件的情况。为解决这种问题，我们可以在url后面增加一个$Rev$的参数。如：../style.css?v=$Rev$ 或 ../base.js?v=$Rev$