Chromium 通过IDL方式添加扩展API

基于chromium103版本

1. 自定义扩展API接口

chromium默认扩展api接口中有chrome.runtime.*,和chrome.send.*等，现在我们就仿照chrome.runtime方式来定义自己的接口，供给插件或者网页使用。

其实chromium 增加自定义 api 接口，在原生代码中添加有两种方式，一种是使用json定义，另外一种是使用idl定义。json方式比较繁琐，不太便利，新版本chromium基本推荐使用IDL方式来定义接口。

原生的api接口代码根据作用不同，分布在不同位置：

chrome使用的API所在位置（文件路径在src/chrome/browser/extensions/）：

chrome\browser\extensions\api
chrome\browser\extensions\*
chrome\common\extensions\api
chrome\common\extensions\*

chrome公共使用所在位置（文件路径在src/extensions/browser/）：

extensions\*
extensions\browser\api
extensions\common\api
extensions\common\mojom

2. 自定义一个接口myInterface.print

3.  新增一个myInterface.idl文件

src\chrome\common\extensions\api\myInterface.idl

// Use the chrome.myInterface API to myInterface
namespace myInterface{
  // myInterface State.
  enum EchoState {
    OK,
    ERROR
  };
  callback EchoStateCallback = void(EchoState state, DOMString out);

  interface Functions {
    // pring string.
    static void print(DOMString input, EchoStateCallback callback);
  };
};

4. 实现C++接口头文件（在下面文件路径新增一个myInterface.h）

src\chrome\browser\extensions\api\myInterface\myInterface_api.h

#ifndef CHROME_BROWSER_EXTENSIONS_API_MYINTERFACE_MYINTERFACE_API_H_
#define CHROME_BROWSER_EXTENSIONS_API_MYINTERFACE_MYINTERFACE_API_H_

#include "extensions/browser/extension_function.h"

namespace extensions {

class MyInterfacePrintFunction : public ExtensionFunction {
 public:
  MyInterfacePrintFunction () = default;
  MyInterfacePrintFunction (
      const MyInterfacePrintFunction &) = delete;
  MyInterfacePrintFunction & operator=(
      const MyInterfacePrintFunction &) = delete;
  DECLARE_EXTENSION_FUNCTION("myInterface.print", MYINTERFACE_PRINT)

 protected:
  ~MyInterfacePrintFunction () override = default;

  // ExtensionFunction overrides.
  ResponseAction Run() override;
};


}  // namespace extensions

#endif  // CHROME_BROWSER_EXTENSIONS_API_MYINTERFACE_MYINTERFACE_API_H_

5. 实现C++接口CC文件（在下面文件路径新增一个myInterface.cc）

src\chrome\browser\extensions\api\myInterface\myInterface_api.cc

#include "chrome/browser/extensions/api/myInterface/myInterface_api.h"
// 这个是自动生成的,在目录"gen\chrome\common\extensions\api"下
#include "chrome/common/extensions/api/myInterface.h"

namespace extensions {

//MyInterfacePrintFunction
ExtensionFunction::ResponseAction MyInterfacePrintFunction::Run() {
  std::unique_ptr param =
      api::myInterface::print::Params::Create(*args_);
  EXTENSION_FUNCTION_VALIDATE(param.get());
  
  return RespondNow(ArgumentList(
  api::myInterface::print::Results::Create(api::myInterface::EchoState::ECHO_STATE_OK, "echo " + param->input)));
}

}  // namespace extensions

6. 添加编译文件

src\chrome\browser\extensions\BUILD.gn

"api/myInterface/myInterface_api.cc",
"api/myInterface/myInterface_api.h",

7. 设置 api 接口权限

在 _api_features.json 文件末尾添加如下内容：

src\chrome\common\extensions\api\_api_features.json

,
  "myInterface": [{
    "channel": "stable",
    "contexts": ["blessed_extension"]
  }, {
    "contexts": "all",
    "channel": "stable",
    "matches": [""]
  }]

在 _permission_features.json文件末尾添加如下内容：

src\chrome\common\extensions\api\_permission_features.json 

,
  "myInterface": {
    "channel": "stable",
    "extension_types": ["extension", "legacy_packaged_app", "hosted_app", "platform_app"]
  }

8. 添加接口定义文件编译项

在api_sources.gni添加中接口定义文件：
src\chrome\common\extensions\api\api_sources.gni

schema_sources_ = [
...
myInterface.idl,
]

在 src\chrome\common\extensions\api\generated_externs_list.txt 末尾添加 afree.idl

9. 添加注册信息及常量定义

在src\chrome\common\extensions\permissions\chrome_api_permissions.cc文件中，找到constexpr APIPermissionInfo::InitInfo permissions_to_register[] =，添加如下内容：

constexpr APIPermissionInfo::InitInfo permissions_to_register[] = {
...
    {APIPermissionID::kMyInterface, "myInterface"},
};

在 src\extensions\browser\extension_function_histogram_value.h 文件宏定义末尾根据具体宏定义的值添加自己的宏定义，在最大值的基础上加1

enum HistogramValue {
...
  AUTOTESTPRIVATE_ACTIVATEAPPWINDOW = 1864,
  MYINTERFACE_PRINT = 1865,
  // Last entry: Add new entries above, then run:
  // python tools/metrics/histograms/update_extension_histograms.py
  ENUM_BOUNDARY
};

10. 定义 APIPermissionID 值

在src\extensions\common\mojom\api_permission_id.mojom 中，定义自己的 api id，在最大值的基础上加1

enum APIPermissionID {
...
  kScripting = 566,
  kMyInterface= 567,
...
}

11. 编译生成即可

ninja -C out\DebugX64 chrome

12. 调用方法

chrome.myInterface.print("hello world",function(state,out){console.log(state,out)})