NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤

时间:2022-09-09 17:48:07

目录(?)[+]

前面一段时间关注了用firebreath开发插件,但是感觉用起来不是那么得心应手,还是回到NPAPI开发插件上来。

本文根据NPAPI开发详解,Windows版进行开发,其中以VS2008为例进行开发,在VS2010中基本上是相同的。
必须的plugin sdk,将其解压到某个目录下,我这里是:D:\Users\zcf\Documents\My Program\2012。下面是创建插件的步骤:

1、创建项目

NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
名称一定要以np开头,为了将来适应不同操作系统,最好全小写,不要太长,尽量控制在8字符内。本例定义为npmedia
位置指定到~plugin\sdk\samples
点击确定、下一步。选择dll、空项目:

NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
点击完成,即建立好了一个空项目。如下图:
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤

2、添加必要文件

首先,添加NPAPI SDK中的Common文件,共三个:
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
然后添加def文件:
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
编辑npdemo.def为:
[cpp] view plaincopy
  1. LIBRARY "npmedia"  
  2.   
  3. EXPORTS  
  4. NP_GetEntryPoints @1  
  5. NP_Initialize @2  
  6. NP_Shutdown @3  
接着添加资源文件:
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
自动生成了resource.h和npdemo.rc。接着修改rc文件:
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
在图中的BLOCK内添加。注意!BLOCK 一定要为"040904e4"
VALUE "MIMEType", "application/media-plugin"

NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤

注意:有很多朋友反映按照本文的方法做出的插件在chrome中无法识别,问题就在于此处,将下一个字段改为如下形式就可以了:

BLOCK "VarFileInfo"
BEGIN
VALUE "Translation", 0x409, 1252
END

这里补充一点:BLOCK  "040904e4"与后面VALUE "Translation", 0x409, 1252的含义是对应的,1252的十六进制表示就是4e4.Translation字段的第一个值表示语言409表示英语,而默认的804表示中文(简体)。Translation字段的第二个值表示所采用的字符集,1200(0X04B0)表示unicode,1252(0X04E4)表示多字节字符集,请参考:http://msdn.microsoft.com/zh-cn/library/windows/desktop/aa381057%28v=vs.85%29.aspx。对于用中文环境开发来讲既可以用409(英语)也可以用804(中文)

BLOCK 的值对于firefox必须是 "040904e4",有朋友提到在chrome中这个BLOCK 的值可以是"080404e4"

如果要支持chrome则字符集应设置为1252(0X04E4)如要及支持firefox又支持chrome,保险的做法是

BLOCK  "040904e4"对应"Translation", 0x409, 1252。


3、添加Plugin实现类

NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
类名可以随便命名,但是必须继承自nsPluginInstanceBase。
编辑Plugin.h:

[cpp] view plaincopy
  1. #pragma once  
  2. #include "pluginbase.h"  
  3.   
  4. class Plugin :  
  5. public nsPluginInstanceBase  
  6. {  
  7. private:  
  8. NPP m_pNPInstance;  
  9. NPBool m_bInitialized;  
  10. public:  
  11. Plugin(NPP pNPInstance);  
  12. ~Plugin();  
  13.   
  14. NPBool init(NPWindow* pNPWindow) { m_bInitialized = TRUE; return TRUE;}  
  15. void shut() { m_bInitialized = FALSE; }  
  16. NPBool isInitialized() { return m_bInitialized; }  
  17. };  


编辑Plugin.cpp:


[cpp] view plaincopy
  1. #include "Plugin.h"  
  2.   
  3. ////// functions /////////  
  4. NPError NS_PluginInitialize()  
  5. {  
  6. return NPERR_NO_ERROR;  
  7. }  
  8.   
  9. void NS_PluginShutdown()  
  10. {  
  11. }  
  12.   
  13. nsPluginInstanceBase * NS_NewPluginInstance(nsPluginCreateData * aCreateDataStruct)  
  14. {  
  15. if(!aCreateDataStruct)  
  16. return NULL;  
  17.   
  18. Plugin * plugin = new Plugin(aCreateDataStruct->instance);  
  19. return plugin;  
  20. }  
  21.   
  22. void NS_DestroyPluginInstance(nsPluginInstanceBase * aPlugin)  
  23. {  
  24. if(aPlugin)  
  25. delete (Plugin *)aPlugin;  
  26. }  
  27.   
  28. ////// Plugin /////////  
  29. Plugin::Plugin(NPP pNPInstance):nsPluginInstanceBase(),  
  30. m_pNPInstance(pNPInstance),  
  31. m_bInitialized(FALSE)  
  32. {  
  33. }  
  34.   
  35.   
  36. Plugin::~Plugin(void)  
  37. {  
  38. }  

4、修改项目属性

NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
字符集选择为多字节字符(不是必须的),下面添加包含文件:
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤

5、编译调试

完成了上述设置就可以进行编译调试了。
这是整个项目的结构:

NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
生成该项目之后,可以在项目的Debug目录下找到dll文件,这里是npmedia.dll。可以写注册表注册这个dll,也可以将这个dll复制到用来测试插件的Firefox的profile目录下的plugins(没有则自行创建)文件夹中。
写注册表的方式:运行regedit,在HKEY_LOCAL_MACHINE\SOFTWARE\MozillaPlugins下建立一个子项,可随意命名:这里以@zcf.com/media为例,新建字符串项Path,其值为生成的dll的路径:

NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤

注意,这种方式在XP系统下测试通过,在WIN7系统下没有成功(注意:win7 64位应运行 %windir%\SysWOW64\Regedit.exe,打开的就是64注册表,可以在HKEY_LOCAL_MACHINE\SOFTWARE\MozillaPlugins下看到很多64位版本的插件,多谢网友 Jearol 告知)。还有一种方式就是设置项目属性,将输出目录指定为用来调试的Firefox相应profile目录下的plugins目录。这样就不用每次生成之后来回复制dll。如下图:

NPAPI插件开发详细记录:用VS2010开发NPAPI插件步骤
然后在Firefox地址栏中输入about:plugins就可以看到我们的插件了。
测试页面可以如下:
测试文件mediatest.html:

[html] view plaincopy
  1. <!doctype html>  
  2. <html>  
  3. <title>TEST WEB PAGE for media plugin</title>  
  4. <body>  
  5. <object type="application/media-plugin" width=200 height=150 ></object>  
  6. <br />  
  7. </body>  
  8. </html>  

关于调试插件:首先用Firefox打开测试页面,然后在VS2010中需要的地方设置断点,接着选择调试/附加到进程在弹出的对话框中选择plugin-container.exe,可能不止一个,注意根据其路径选择正确的那个。最后刷新测试页面就可以在你设置的断点的地方断下,进行调试。下一篇文章会有一个简单的实例展示这个调试过程。