Piwik学习 -- 插件开发

简介:

本文目的

最近为了给自己的web系统添加一个运营数据分析和展示的功能,本打算自己纯手工打造,但是发现成本太高,时间和精力方面不允许。在网上查阅了一些资料,发现目前有许多开源的web数据分析系统,所以拿来主意,决定找一个合适的开源web分析工具。最终选择了piwik,理由如下:

  1. Piwik采用LAMP开发,我的系统也是,所以可以复用运营环境。
  2. Piwik的架构设计比较通用,可以开发插件进行扩展。
  3. Piwik的数据显示比较强大,至少看上去如此。例如有曲线图,直方图,饼图,标签云等等。插件可以通过拖拽的方式任意布置。
  4. 开源,免费,并且有相对完整的文档。

经过了一段时间的摸索,我终于将开发插件的流程梳理清楚了,记录于此,作为备忘。目前使用的Piwik是1.9.2版本(当前最新版本),这点很重要。Piwik的部分接口不向前兼容,以至于很多基于早期版本开发的插件在当前版本无法使用(吐槽:Piwik官方网站上提供的第三方插件几乎都不能在1.9.2上正常运行)。本文的主要内容如下:

  • Piwik工作原理
  • 安装部署Piwik
  • 安装Piwik插件
  • Piwik插件结构
  • Hello World,你懂的!
  • Piwik模版
  • Piwik图形视图
  • 待了解的地方 ……

 

Piwik工作原理

Piwik是一个web系统,主要用于web运营分析。它会部署在你自己的apache和mysql中,这样运营数据都在你自己的服务器里!安装好Piwik后,它会提供一段js代码,你只需要将这些代码嵌入到你web中的每个网页中(如果你的系统是用模版开发的,具有相同的footer模版,那么这里最适合放入这段代码),那么每当这些网页被访问时,这些数据就会传回给Piwik服务器。这里会有个问题,由于数据收集代码放在html中,那么异步请求无法被统计到,因为这些请求不会返回完整的页面,而是部分页面或数据。不要紧,piwik提供web日志分析的功能(具体配置见这里),这样就可以统计出所有的访问数据。

 

安装部署Piwik

安装Piwik的确很简单:下载开发包,解压到apahce服务器web根目录,配置piwik。Piwik在第一次访问时,提供了一个非常简介的安装向导,指导你一步一步的配置好piwik,具体步骤见这里

 

安装Piwik插件

插件的安装也很简单,只需要将插件拷贝到piwik_src/plugins目录下面,然后去piwik配置页面启用插件。具体步骤,参见这里

 

Piwik插件结构

Piwik源代码目录下的plugins目录中是Piwik官方插件,其实官方插件是最好的学习参考。要创建你自己的第一个插件,首先需要给插件取一个响亮的名称,这里就姑且称之为“BourneliPlugin”吧!然后创建目录piwik_src/plugins/BourneliPlugin。接下来,需要在此目录下,创建两个比较重要的文件:

  • BourneliPlugin.php:定义插件的基本信息、插件的位置
  • Controller.php:插件的CGI方法,可以理解为Web MVC模式中的Controller,Piwik框架会将插件相关的Url映射到Controller.php中的方法。

 

Hello World,你懂的!

按照上面的目录结构,你的第一个插件的基本骨架就搭建成功了,现在我们来写点什么,实现我们的第一个“Hello World”吧。先看看BourneliPlugin.php代码,如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<? php
class Piwik_BourneliPlugin extends Piwik_Plugin {
     /**
      * 插件描述信息。
      */
     public function getInformation(){
         return array(
             'description' => '这时bourneli的插件',
             'homepage' => 'http://qfs.sng.local/',
             'author' => 'bourneli',
             'author_homepage' => 'http://cnblogs.com/bourneli/',
             'license' => 'GPL v3 or later',
             'license_homepage' => 'http://www.gnu.org/licenses/gpl.html',
             'version' => '0.1',
             'translationAvailable' => false,
         );
     }
 
     // 加载插件
     function postLoad(){
         Piwik_AddWidget('Bourneli Test', 'hello world', 'BourneliPlugin', 'helloWorld');
     }
}

上面的代码主要定义的插件的基本信息和插件挂接的位置,需要注意一下几点:

  1. 类的名称必须是Piwik_BourneliPlugin并且继承类Piwik_Plugin。聪明的你可能已经发现类名的规律:Piwik_<YourPluginName>(大小写不敏感)。确实,<YourPluginName>代表插件目录和插件文件的名称。如果不按照这个约定,piwik是无法找到插件。
  2. 需要实现getInformation函数,此函数返回插件描述信息,方便在Piwik的插件管理器中找到我们的插件。
  3. 实现postLoad方法,在此方法中挂接插件。此方法有四个参数,分别是,widgetCategory,widgetName,ControllerName和ControllerAction,前面两个主要是显示作用,用于在主界面的widget管理器中找到你的插件。第三个方法是控制器方法,对应Controller.php中的类,第四个参数是第三个参数对应类中的具体方法,用于响应用户的请求。

接下来看看Controller.php中的代码:

1
2
3
4
5
6
7
8
9
<? php
class Piwik_BourneliPlugin_Controller extends Piwik_Controller{
     function helloWorld(){
         echo 'This is hello from Bourneli<br/>';
         echo 'This is hello from Bourneli< br />';
         echo 'This is hello from Bourneli< br />';
         echo 'This is hello from Bourneli< br />';
     }
}

对,你没有看错,Controller.php中的代码就是这么简单!需要注意一下几点

  1. 类的名称遵循这个规律:Piwik_<YourPluginName>_Controller,否则Piwik_AddWidget的第三个参数无法找到对应类。
  2. 类继承Piwik_Controller类
  3. helloWorld方法对应Piwik_AddWidget函数的第四个参数,输出将直接显示在widget的面板中。

OK,写完了代码,现在可以将BourneliPlugin整个目录拷贝到piwik_src/plugins目录下,看看效果了。

首先,进入插件管理页面,如下图:

clip_image002

对应导航:setting à Plugings à BourneliPlugin。可以看到description这一栏中显示的文本就是在getInformation函数中对应的字段输出的信息。点击最右边的“Active”,启用插件(否则不会出现在widget面板中)。

接下来,去widget面板中打开我们的“hello world”插件。如下图:

clip_image004

可以看到Piwik_AddWidget函数中的第一个和第二个参数出现在哪里?最后点击“hello world”,可以到我们的插件出现在Dashboard中,如下图:

clip_image006

 

Piwik模版

使用PHP开发web,一般都会使用模版机制,这样可以将view和model分开。Piwik也提供模版功能,Piwik没有自己造车,而是直接使用了smarty模版库,所以使用过smarty的同学一定不会陌生。即时没有使用过,smarty的官方文档比较完备,可以网上搜索查阅。接下来演示一个例子,看看如何在插件中使用模版。首先,在BournliPlugin目录下添加一个templates目录,并且在templates目录中添加文件myTpl.tpl,内容如下:

1
2
This is a string '{$myString}' from template.< br >
< h1 >今天的天气真实糟透了!</ h1 >

(写这篇文章的时候天气真的很糟!)

然后在Controller.php中添加下面的代码(前面例子中出现的代码备省略了):

1
2
3
4
5
6
7
8
9
<?php
class  Piwik_BourneliPlugin_Controller extends  Piwik_Controller{
     …… 
     function  templateDemo(){
         $view  = Piwik_View::factory( 'myTpl' );
         $view ->myString = 'okkkkkkkkkkkkkk' ;
         echo  $view ->render();
     }
}

添加的函数是一个新的插件函数,用于模版调用,可以看到第一行使用Piwik的视图工厂,加载一个视图对象,并将此对象与模版绑定。然后直接将字符串“okkkkkkkkkkkkkk”赋值给模版中的变量myString,最后渲染并输出。

还没完,虽然写了这个函数,但是没有将其挂接到Piwik的widget面板中(即时不挂接面板,也可以访问,有兴趣的读者可以通过抓包看看如何访问),在BourneliPlugin.php中添加下面的代码:

1
2
3
4
5
6
7
8
9
<?php
class  Piwik_BourneliPlugin extends  Piwik_Plugin {
     ...
     // 加载插件
     function  postLoad(){
         ...
         Piwik_AddWidget( 'Bourneli Test' , 'template demo' , 'BourneliPlugin' , 'templateDemo' );
     }
}

为了突出重点,前面相同的代码已经省略。我们来看看效果,如下:

clip_image008

 

Piwik图形视图

Piwik内置了一些图形视图,比如趋势图,直方图,饼图,云图等。并且提供了十分简单的API供我们调用,我们所做的只是提供数据。先来看看几种图形:

clip_image010

感觉是不是很拉风!使用上面的功能很简单,可以通过Piwik_src/plugins/ExampleUI这个插件来了解具体的使用,此插件专门用作demo。我在这里简要说名一下步骤:

  1. 首先在BourneliPlugin目录下创建名为API.php的文件,在此文件中创建名为Piwik_BourneliPlugin_API的类,命名规则为Piwik_YourPluginName_API。需要注意,此类必须实现单一模式
  2. Piwik_BourneliPlugin_API中的方法主要是用于获取数据并将你的数据填充到名为Piwik_DataTable的容器中,该类是Piwik自定义类,用于统一数据格式。
  3. 最后在Controller中的CGI方法中将对应视图与API中的数据提供方法链接起来,就可以完成数据展示了。

这里提供实验的完整例子,读者也可以查看Piwik官方提供的ExampleUI这个例子中的源代码,相信会更好,因为本人也是参照这个例子完成实验的。同时,不要忘记直接查看Piwik的源代码,这样会更直接。

 

待了解的地方

  1. 目前还不太清楚如何使用Piwik收集的PV,UV数据,也不知道如何扩展Piwik数据收集和数据处理功能,这些是后续需要梳理清除的重点。
  2. 需要了解Piwik整体实现的框架,粗略看了一下Piwik的代码,发现写得还是比较优美的,这种插件化设计必然值得学习和掌握。
  3. Piwik还可以将他自己的一些widget集成到其他系统中,这样可以提供多途径了解系统的状态,所以也是需要学习的。

 

参考资料

Piwik官方网站:http://piwik.org/

 

OK,终于将这篇流水账文章写完了,竟然用了一年时间(2012年12月31日起草,2013年1月1~3日法定假日,2013年1月4日写完)!希望对你有用!

 

版权声明原创作品,允许转载,转载时请以超链接方式标明出处,谢谢合作。

本文转自bourneli博客园博客,原文链接:http://www.cnblogs.com/bourneli/archive/2013/01/04/2844736.html ,如需转载请自行联系原作者
相关文章
|
2月前
|
负载均衡 数据可视化 NoSQL
强烈推荐,好用的时序图开源插件PlantUML!
PlantUML这个开源时序图插件,它通过简单的语法和自动化的图形线条关联解决了传统画图软件中对齐困难、逻辑判断不易表示等问题,并提供了美观的图形和易于修改的特点,特别适合新入职场的开发者快速上手绘制高质量的时序图。
强烈推荐,好用的时序图开源插件PlantUML!
|
5月前
|
资源调度 JavaScript 搜索推荐
《VitePress 简易速速上手小册》第9章 VitePress 的扩展与插件(2024 最新版)
《VitePress 简易速速上手小册》第9章 VitePress 的扩展与插件(2024 最新版)
343 0
jira学习案例30-安装和使用ant库2
jira学习案例30-安装和使用ant库2
77 0
jira学习案例30-安装和使用ant库2
jira学习案例29-安装和使用ant库1
jira学习案例29-安装和使用ant库1
67 0
jira学习案例29-安装和使用ant库1
jira学习案例83-配置redux-tookit
jira学习案例83-配置redux-tookit
65 0
jira学习案例83-配置redux-tookit
|
JSON 数据格式 开发者
用gitbook写一篇开源文档并不难
如何基于 gitbook 搭建文档站点,不涉及开源文档编写规范。
228 0
|
JavaScript 前端开发 开发工具
很方便的javascript开发工具--火狐的Scratchpad(代码草稿本)工具
火狐的console控制台可以很方便的测试单行js代码,就像这样:
133 0
很方便的javascript开发工具--火狐的Scratchpad(代码草稿本)工具
|
搜索推荐 IDE Java
pinpoint插件开发之二:从零开始新建一个插件
从零开始新建pinpoint插件,本篇给出从编码到部署运行的详细步骤
961 0
pinpoint插件开发之二:从零开始新建一个插件