如何编写自己的插件？

Posted

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了如何编写自己的插件？相关的知识，希望对你有一定的参考价值。

参考技术A UBB插件是扩展UBB编辑器功能的开放接口，使用javascript编写。调试插件 UBB插件采用动态加载JavaScript文件的方法，一个插件对应一个JavaScript文件。浏览器安全限制不允许加载本机文件，即类似：file:///c|/temp/plugin.js的文件，所以您得有一个站点服务器。如果是本机测试，那么IIS或Apache得装上（向您推荐由网友ChrisAK编写的“UBB插件迷你服务器”）。在Firefox中调试如果不能访问localhost或者指定端口那么需配置： 地址栏输入：“about:config”进入配置页面；配置首选项“network.automatic-ntlm-auth.trusted-uris”为“localhost”。配置首选项“network.security.ports.banned.override”为“指定端口”，如：8080。 点击工具条上的UBB插件按钮“”进入插件管理对话框。 将“本机插件URL”输入框中的内容，替换成自己编写的插件所在链接即可装载。 编写插件插件Demo下载地址：plugin.js 插件只需要实现load()（装载）和free()（卸载）两个方法即可被调用。 var CsdnScriptPlugin999 = /// /// 接口版本 /// interfaceVersion: "1.0", /// /// 插件标题，显示给用户看 /// caption: "插件标题", /// /// 设计者在CSDN的ID /// designer: "unknown", /// /// 按钮对象，可选项 /// buttons: , /// /// 分隔条对象，可选项 /// separators: , /// /// 装载 /// load: function() this.separators["icon"] = CsdnScriptWorkshop.addSeparator(); // 添加一个分隔条 this.buttons["icon"] = CsdnScriptWorkshop.addButton( // 添加一个工具按钮 this.caption, "按钮图片(16*16 gif)", function() var htmlDialog = "对话框的HTML内容"; var point = absolutePoint(this); // 按钮的位置 CsdnScriptWorkshop.showDialog("标题", htmlDialog, point.x, point.y + 18, 200, 200); ); , /// /// 卸载 /// free: function() for (var button in this.buttons) CsdnScriptWorkshop.deleteButton(this.buttons[button]); for (var separator in this.separators) CsdnScriptWorkshop.deleteSeparator(this.separators[separator]); 本地插件对象名必须为：“CsdnScriptPlugin999” 必须填写的字段：interfaceVersion（接口版本）、caption（标题）、designer（设计人CSDN ID）必须填写的方法：load()（装载插件）、free()（卸载插件）添加工具按钮或分隔条、获得或设置文本框内容通过调用“CsdnScriptWorkshop”对象的方法实现，声明如下： var CsdnScriptWorkshop = /// /// 接口版本 /// interfaceVersion: "1.0", /// /// 获得UBB编辑器 /// /// 返回编辑对象 getEditor: function() ..., /// /// 获得UBB编辑器文本 /// /// 返回全部文本 getEditorText: function() ..., /// /// 设置UBB编辑器文本 /// /// 文本内容 setEditorText: function(value) ..., /// /// 获得UBB编辑器选中文本 /// /// 返回当前选中的文本 getSelectText: function() ..., /// /// 设置UBB编辑器选中文本 /// /// 文本内容 setSelectText: function(value) ..., /// /// 添加工具按钮 /// /// 提示内容 /// 图标URL，16*16，可以通过个人空间上传 /// 点击按钮执行的函数 /// 返回添加的按钮对象 addButton: function(hint, icon, click) ..., /// /// 删除工具按钮 /// /// 按钮对象 deleteButton: function(button) ..., /// /// 添加工具分隔条 /// /// 返回添加的分隔条对象 addSeparator: function() ..., /// /// 删除工具分隔条 /// /// 分隔条对象 deleteSeparator: function(separator) ..., /// /// 显示对话框 /// /// 标题/// 显示的html内容 /// 左边距 /// 上边距 /// 宽度/// 高度showDialog: function(title, html, left, top, width, height) ..., /// /// 关闭对话框 /// closeDialog: function() ... 控制对话框显示位置或保存用户使用习惯可以调用如下公用函数： /// /// 获得元素的绝对坐标对象(访问x,y字段) /// /// HTML元素 /// 返回元素所在的绝对坐标 function absolutePoint(element) ... /// /// 设置Cookie值 /// /// Cookie变量名 /// Cookie值 /// 保存的天数 function setCookie(name, value, days) ... /// /// 获取Cookie值 /// /// Cookie变量名 /// 返回获取到的Cookie值 function getCookie(name) ... 推荐自己的插件如果想让更多的网友分享到您的创意和乐趣，那么赶紧向我们发邮件推荐您的插件吧。本回答被提问者采纳 参考技术B 一种是类级别的插件开发，即给jQuery添加新的全局函数，相当于给jQuery类本身添加方法。jQuery的全局函数就是属于jQuery命名空间的函数，另一种是对象级别的插件开发，即给jQuery对象添加方法。
下面就两种函数的开发做详细的说明。
1、类级别的插件开发
类级别的插件开发最直接的理解就是给jQuery类添加类方法，可以理解为添加静态方法。典型的例子就是$.AJAX()这个函数，将函数定义于jQuery的命名空间中。关于类级别的插件开发可以采用如下几种形式进行扩展：
1.1 添加一个新的全局函数
添加一个全局函数，我们只需如下定义：
Java代码
jQuery.foo = function()
alert('This is a test. This is only a test.');
;

1.2 增加多个全局函数
添加多个全局函数，可采用如下定义：
Java代码
jQuery.foo = function()
alert('This is a test. This is only a test.');
;
jQuery.bar = function(param)
alert('This function takes a parameter, which is "' + param + '".');
;
调用时和一个函数的一样的:jQuery.foo();jQuery.bar();或者$.foo();$.bar('bar');
1.3 使用jQuery.extend(object);
Java代码
jQuery.extend(
foo: function()
alert('This is a test. This is only a test.');
,
bar: function(param)
alert('This function takes a parameter, which is "' + param +'".');

);

1.4 使用命名空间
虽然在jQuery命名空间中，禁止使用了大量的javaScript函数名和变量名。但是仍然不可避免某些函数或变量名将于其他jQuery插件冲突，因此习惯将一些方法封装到另一个自定义的命名空间。
Java代码
jQuery.myPlugin =
foo:function()
alert('This is a test. This is only a test.');
,
bar:function(param)
alert('This function takes a parameter, which is "' + param + '".');

;
采用命名空间的函数仍然是全局函数，调用时采用的方法：
$.myPlugin.foo();
$.myPlugin.bar('baz');

通过这个技巧（使用独立的插件名），可以避免命名空间内函数的冲突。
2、对象级别的插件开发
对象级别的插件开发需要如下的两种形式：、
形式1：
Java代码
(function($)
$.fn.extend(
pluginName:function(opt,callback)
// Our plugin implementation code goes here.

)
)(jQuery);
形式2：
Java代码
(function($)
$.fn.pluginName = function()
// Our plugin implementation code goes here.
;
)(jQuery);
上面定义了一个jQuery函数,形参是$，函数定义完成之后,把jQuery这个实参传递进去.立即调用执行。这样的好处是,在写jQuery插件时,也可以使用$这个别名,而不会与prototype引起冲突.
2.1 在JQuery名称空间下申明一个名字
这是一个单一插件的脚本。如果你的脚本中包含多个插件，或者互逆的插件（例如： $.fn.doSomething() 和$.fn.undoSomething()），那么需要声明多个函数名字。但是，通常当我们编写一个插件时，力求仅使用一个名字来包含它的所有内容。示例插件命名为“highlight“

Java代码
$.fn.hilight = function()
// Our plugin implementation code goes here.
;
我们的插件通过这样被调用：
$('#myDiv').hilight();

2.2 接受options参数以控制插件的行为
插件添加功能指定前景色和背景色的功能。也许会让选项像一个options对象传递给插件函数。例如：
Java代码
// plugin definition
$.fn.hilight = function(options)
var defaults =
foreground: 'red',
background: 'yellow'
;
// Extend our default options with those provided.
var opts = $.extend(defaults, options);
// Our plugin implementation code goes here.
;
插件可以这样被调用：
$('#myDiv').hilight(
foreground: 'blue'
);

2.3 暴露插件的默认设置
应该对上面代码的一种改进是暴露插件的默认设置。这对于让插件的使用者更容易用较少的代码覆盖和修改插件。接下来开始利用函数对象。

Java代码
// plugin definition
$.fn.hilight = function(options)
// Extend our default options with those provided.
// Note that the first arg to extend is an empty object -
// this is to keep from overriding our "defaults" object.
var opts = $.extend(, $.fn.hilight.defaults, options);
// Our plugin implementation code goes here.
;
// plugin defaults - added as a property on our plugin function
$.fn.hilight.defaults =
foreground: 'red',
background: 'yellow'
;
现在使用者可以包含像这样的一行在他们的脚本里：
//这个只需要调用一次，且不一定要在ready块中调用
$.fn.hilight.defaults.foreground = 'blue';
接下来像这样使用插件的方法，结果它设置蓝色的前景色：
$('#myDiv').hilight();

如所见，允许使用者写一行代码在插件的默认前景色。而且使用者仍然在需要的时候可以有选择的覆盖这些新的默认值：
// 覆盖插件缺省的背景颜色
$.fn.hilight.defaults.foreground = 'blue';
// ...
// 使用一个新的缺省设置调用插件
$('.hilightDiv').hilight();
// ...
// 通过传递配置参数给插件方法来覆盖缺省设置
$('#green').hilight(
foreground: 'green'
);
2.4 适当的暴露一些函数
这段将会一步一步对前面那段代码通过有意思的方法扩展插件（同时让其他人扩展插件）。例如，插件的实现里面可以定义一个名叫"format"的函数来格式化高亮文本。插件现在看起来像这样，默认的format方法的实现部分在hiligth函数下面。
Java代码
// plugin definition
$.fn.hilight = function(options)
// iterate and reformat each matched element
return this.each(function()
var $this = $(this);
// ...
var markup = $this.html();
// call our format function
markup = $.fn.hilight.format(markup);
$this.html(markup);
);
;
// define our format function
$.fn.hilight.format = function(txt)
return '<strong>' + txt + '</strong>';
;
很容易的支持options对象中的其他的属性通过允许一个回调函数来覆盖默认的设置。这是另外一个出色的方法来修改你的插件。这里展示的技巧是进一步有效的暴露format函数进而让他能被重新定义。通过这技巧，是其他人能够传递自己设置来覆盖插件，换句话说，这样其他人也能够为插件写插件。
插件中定义就像这样：
$.fn.cycle.transitions =
// ...
;
这个技巧使其他人能定义和传递变换设置到Cycle插件。
2.5 保持私有函数的私有性
这种技巧暴露你插件一部分来被覆盖是非常强大的。
为了创建一个闭包，将包装整个插件定义在一个函数中。
Java代码
(function($)
// plugin definition
$.fn.hilight = function(options)
debug(this);
// ...
;
// private function for debugging
function debug($obj)
if (window.console && window.console.log)
window.console.log('hilight selection count: ' + $obj.size());
;
// ...
)(jQuery);

“debug”方法不能从外部闭包进入,因此对于我们的实现是私有的。
2.6 支持Metadata插件
在正在写的插件的基础上，添加对Metadata插件的支持能使他更强大。个人来说，喜欢这个Metadata插件，因为它让你使用不多的"markup”覆盖插件的选项（这非常有用当创建例子时）。而且支持它非常简单。更新：注释中有一点优化建议。
Java代码
$.fn.hilight = function(options)
// ...
// build main options before element iteration
var opts = $.extend(, $.fn.hilight.defaults, options);
return this.each(function()
var $this = $(this);
// build element specific options
var o = $.meta ? $.extend(, opts, $this.data()) : opts;
//...
这些变动行做了一些事情：它是测试Metadata插件是否被安装如果它被安装了，它能扩展我们的options对象通过抽取元数据这行作为最后一个参数添加到JQuery.extend，那么它将会覆盖任何其它选项设置。现在能从"markup”处驱动行为,如果选择了“markup”：
调用的时候可以这样写： jQuery.foo(); 或 $.foo();

Java代码
<!-- markup -->
<div class="hilight background: 'red', foreground: 'white' ">
Have a nice day!
</div>
<div class="hilight foreground: 'orange' ">
Have a nice day!
</div>
<div class="hilight background: 'green' ">
Have a nice day!
</div>
现在我们能高亮哪些div仅使用一行脚本：
$('.hilight').hilight();

2.7 整合
下面使我们的例子完成后的代码：

Java代码
// 创建一个闭包
(function($)
// 插件的定义
$.fn.hilight = function(options)
debug(this);
// build main options before element iteration
var opts = $.extend(, $.fn.hilight.defaults, options);
// iterate and reformat each matched element
return this.each(function()
$this = $(this);
// build element specific options
var o = $.meta ? $.extend(, opts, $this.data()) : opts;
// update element styles
$this.css(
backgroundColor: o.background,
color: o.foreground
);
var markup = $this.html();
// call our format function
markup = $.fn.hilight.format(markup);
$this.html(markup);
);
;
// 私有函数：debugging
function debug($obj)
if (window.console && window.console.log)
window.console.log('hilight selection count: ' + $obj.size());
;
// 定义暴露format函数
$.fn.hilight.format = function(txt)
return '<strong>' + txt + '</strong>';
;
// 插件的defaults
$.fn.hilight.defaults =
foreground: 'red',
background: 'yellow'
;
// 闭包结束
)(jQuery);

这段设计已经让我创建了强大符合规范的插件。我希望它能让你也能做到。
3、总结
jQuery为开发插件提拱了两个方法，分别是：
jQuery.fn.extend(object); 给jQuery对象添加方法。
jQuery.extend(object); 为扩展jQuery类本身.为类添加新的方法。
3.1 jQuery.fn.extend(object);
fn 是什么东西呢。查看jQuery代码，就不难发现。
jQuery.fn = jQuery.prototype =
init: function( selector, context ) //....
//......
;
原来 jQuery.fn = jQuery.prototype.对prototype肯定不会陌生啦。虽然 javascript　没有明确的类的概念，但是用类来理解它，会更方便。jQuery便是一个封装得非常好的类，比如我们用 语句　$("#btn1") 会生成一个 jQuery类的实例。
jQuery.fn.extend(object); 对jQuery.prototype进得扩展，就是为jQuery类添加“成员函数”。jQuery类的实例可以使用这个“成员函数”。
要开发一个插件，做一个特殊的编辑框，当它被点击时，便alert 当前编辑框里的内容。可以这么做：
$.fn.extend(
alertWhileClick:function()
$(this).click(function()
alert($(this).val());
);

);
$("#input1").alertWhileClick(); //页面上为：<input id="input1" type="text"/>
$("#input1")　为一个jQuery实例，当它调用成员方法 alertWhileClick后，便实现了扩展，每次被点击时它会先弹出目前编辑里的内容。
3.2 jQuery.extend(object);
为jQuery类添加添加类方法，可以理解为添加静态方法。如：
$.extend(
add:function(a,b)return a+b;
);
便为　jQuery　添加一个为 add　的　“静态方法”，之后便可以在引入 jQuery　的地方，使用这个方法了，$.add(3,4); //return 7

iOS之深入解析如何编写自己的CocoaPods插件

一、前言

  • Cocoapods 有很多比较实用的小插件，比如 cocoapods-open （ 执行 pod open 可以直接打开 .xcworkspace 文件），这些插件 gem 都有特定的目录分层。一开始以为自己要从零开始配置，后来发现 cocoapods-plugin 本身就提供了用来创建一个模版工程的 create 命令。
  • 输入以下命令即可创建一个模版工程：
// 安装
gem install cocoapods-plugins
// 创建
pod plugins create NAME [TEMPLATE_URL]
  • 在这个需求中，创建一个 author 子命令，输入：
pod plugins create author
  • 当前路径下会生成 cocoapods-author 目录，其结构如下：
.
├── Gemfile
├── LICENSE.txt
├── README.md
├── Rakefile
├── cocoapods-author.gemspec
├── lib
│   ├── cocoapods-author
│   │   ├── command
│   │   │   └── author.rb
│   │   ├── command.rb
│   │   └── gem_version.rb
│   ├── cocoapods-author.rb
│   └── cocoapods_plugin.rb
└── spec
    ├── command
    │   └── author_spec.rb
    └── spec_helper.rb
  • author.rb 的初始内容如下：
module Pod
  class Command
    # This is an example of a cocoapods plugin adding a top-level subcommand
    # to the 'pod' command.
    #
    # You can also create subcommands of existing or new commands. Say you
    # wanted to add a subcommand to `list` to show newly deprecated pods,
    # (e.g. `pod list deprecated`), there are a few things that would need
    # to change.
    #
    # - move this file to `lib/pod/command/list/deprecated.rb` and update
    #   the class to exist in the the Pod::Command::List namespace
    # - change this class to extend from `List` instead of `Command`. This
    #   tells the plugin system that it is a subcommand of `list`.
    # - edit `lib/cocoapods_plugins.rb` to require this file
    #
    # @todo Create a PR to add your plugin to CocoaPods/cocoapods.org
    #       in the `plugins.json` file, once your plugin is released.
    #
    class Author < Command
      # pod plugins list 时，展示的概要信息
      self.summary = 'Short description of cocoapods-author.'

      # --help / 命令错误时展示的描述信息
      self.description = <<-DESC
        Longer description of cocoapods-author.
      DESC

      # --help / 命令错误时展示的参数信息
      self.arguments = 'NAME'

      def initialize(argv)
        @name = argv.shift_argument
        super
      end

      # 校验方法（查看文件是否存在等）
      def validate!
        super
        help! 'A Pod name is required.' unless @name
      end

      # 运行命令
      def run
        UI.puts "Add your implementation for the cocoapods-author plugin in #__FILE__"
      end
    end
  end
end
  • 如何创建 list 的子命令 deprecated：
    • 移动目标文件至 lib/pod/command/list/deprecated.rb，并且将这个子命令类放进 Pod::Command::List 命名空间中；
    • 更改子命令类的父类为 List；
    • 在 lib/cocoapods_plugins.rb 中载入该文件。
  • 如果不需要子命令，直接继承 Command 就可以。

二、获取 Podfile untagged 组件名

  • 如下所示的人方法返回没有依赖 tag 的组件哈希，为了简单处理，直接获取 target_definitions 第一个元素的 dependencies 作为工程的依赖进行遍历：
UNTAGGED_FLAGS = [:path, :git, :branch, :commit]

def load_untageed_dependencies_hash
  file_path = Dir.pwd + '/Podfile'

  raise %Q[没有找到 Podfile，请确认是否在 Podfile 所在文件夹\\n] unless File.file?(file_path)

  podfile = Podfile.from_file(file_path)
  dependencies = podfile.to_hash['target_definitions'].first['dependencies']

  # UI.puts dependencies

  untageed_dependencies = dependencies.select do |dependency|
    tagged = true
    if dependency.kind_of? Hash
      first = dependency.values.first.first
      if first.kind_of? Hash 
        tagged = first.keys.reduce(true) do |result, flag|
          !UNTAGGED_FLAGS.include?(flag) & result
        end
      elsif first.kind_of? String
        tagged = true   
      end
    elsif dependency.is_a?(String)
      tagged = true 
    end
    !tagged
  end

  untageed_dependencies.reduce() do |result, dependency|
    result.merge(dependency)
  end
end

三、获取本地私有源获取组件的作者

  • 获取本地私有源的组件作者：
def load_pod_authors(spec_files)
  author_hash =   
  spec_files.each do |file|
    if !file.nil? && File.file?(file)
      podspec = Specification.from_file(file)   
      pod_authors = podspec.attributes_hash['authors']

      if pod_authors.kind_of? Hash
        author = pod_authors.keys.first
      elsif pod_authors.kind_of? Array
        author = pod_authors.first
      else
        author = pod_authors
      end
      author = author.downcase

      if !author.nil? && !podspec.name.nil?
        author_hash[author] =  author_hash[author].nil? ? [] : author_hash[author]
        author_hash[author].append(podspec.name)
      end
    end
  end
  author_hash
end
  • 获取组员信息：
def load_boss_keeper_members
  member_hash = 
  @memebrs_hash.uniq.map.each do |nickname| 

    reform_memeber_hash_proc = -> nickname, realname do
      nickname = nickname.downcase unless !nickname.nil?
      pinyin = Pinyin.t(nickname, splitter: '').downcase
      if pinyin != nickname 
        member_hash[nickname] = realname
      end

      member_hash[pinyin] = realname
    end

    if nickname.kind_of? Hash
      name = nickname.keys.first.dup.force_encoding("UTF-8")
      nickname.values.first.append(name).each do |nickname|
        reform_memeber_hash_proc.call(nickname, name)
      enddef load_pod_authors(spec_files)
  author_hash =   
  spec_files.each do |file|
    if !file.nil? && File.file?(file)
      podspec = Specification.from_file(file)   
      pod_authors = podspec.attributes_hash['authors']

      if pod_authors.kind_of? Hash
        author = pod_authors.keys.first
      elsif pod_authors.kind_of? Array
        author = pod_authors.first
      else
        author = pod_authors
      end
      author = author.downcase

      if !author.nil? && !podspec.name.nil?
        author_hash[author] =  author_hash[author].nil? ? [] : author_hash[author]
        author_hash[author].append(podspec.name)
      end
    end
  end
  author_hash
end
    else
      reform_memeber_hash_proc.call(nickname, nickname)
    end
  end
  member_hash
end
  • 如果 @ 组员需要手机号码，那么该部分数据可以从本地的 yaml 文件读取：
file_path = File.join(File.dirname(__FILE__),"boss_keeper_members.yaml")
yaml_hash =     
begin
  YAML.load_file(file_path)
rescue Psych::SyntaxError, Errno::EACCES, Errno::ENOENT
  
end

@memebrs_hash = yaml_hash['members']
@mobiles = yaml_hash["mobiles"].reduce() |result, mobile| result.merge(mobile)
  • 由于作者一栏存在用花名、原名、昵称的情况，所以 yaml 文件基本格式如下：
members:
- 青木:
  - tripleCC

mobiles:
- 青木:
  - 1xxxxxxx

四、匹配本地存储的组员名

  • 首先匹配是组内组员管理的组件，如果是其它组创建的组件，暂时忽略：
def load_valid_pod_authors_hash
  authors_hash = 
  @pod_authors.each do |name, pods|
    member_name = @boss_keeper_members[name.downcase]
    if !member_name.nil?
      member_name = member_name.downcase
      author_pods = authors_hash[member_name].nil? ? [] : authors_hash[member_name]
      authors_hash[member_name] = author_pods.append(pods).flatten
    end
  end
  authors_hash
end
  • 然后将结果和未指定 tag 的组件哈希匹配：
def load_untageed_dependencies_authors_hash
  authors_hash = 
  valid_pod_authors = load_valid_pod_authors_hash
  untageed_dependencies_hash = load_untageed_dependencies_hash
  untageed_dependencies_hash.keys.each do |pod|
    valid_pod_authors.each do  |author, pods|
      if pods.include?(pod)
        authors_hash[author] = authors_hash[author].nil? ? [] : authors_hash[author]
        authors_hash[author].append(pod)
      end
    end
  end
  authors_hash
end

五、整合发送

  • 通过 git rev-parse --abbrev-ref HEAD 获取当前所在分支，然后根据作者、组件名、手机号码创建 curl 命令并执行：
def post_message_to_ding_talk
  current_branch = `git rev-parse --abbrev-ref HEAD`.strip

  untageed_dependencies_authors_hash = load_untageed_dependencies_authors_hash
  untageed_dependencies_authors_hash.each do |author, pods|
    content = author + "，#current_branch分支" + "，下面的仓库打个版本：" + pods.join('，')
    if !@mobiles[author].nil?
      mobile = @mobiles[author].first
    end

    curl = %Q[
    curl 'https://oapi.dingtalk.com/robot/send?access_token=xxxxxxx' \\
       -H 'Content-Type: application/json' \\
       -d '
      
        "msgtype": "text", 
        "text": 
            "content": "#content"
         ,
         "at": 
            "atMobiles": [
              "#mobile"
            ], 
            "isAtAll": false
        
      ']
      # UI.puts curl
    Kernel.system curl
  end
end
  • 如果后续对这个插件进行扩展的话，还应该考虑根据私有源自动生成 Podfile，解决封版时需要手动修改 Podfile 的情况，麻烦而且可能存在把版本号写错的情况。
与50位技术专家面对面 20年技术见证，附赠技术全景图

以上是关于如何编写自己的插件？的主要内容，如果未能解决你的问题，请参考以下文章

iOS之深入解析如何编写自己的CocoaPods插件

新手如何编写jQuery插件

如何编写一个gulp插件

如何编写jQuery插件

burpsuite编写插件--环境安装

Gradle 与 AGP 构建 API: 如何编写插件