如何在Chrome扩展程序中使用jQuery?


128

我正在写一个chrome扩展程序。我想jQuery在我的扩展程序中使用。我没有使用任何背景页面,只是一个背景脚本

这是我的文件:

manifest.json

{
    "manifest_version": 2,

    "name": "Extension name",
    "description": "This extension does something,",
    "version": "0.1",

    "permissions": [
        "activeTab"
    ],

    "browser_action": {
        "default_icon": "images/icon_128.png"
    },

    "background": {
        "scripts": ["background.js"],
        "persistent": false
    },

    "icons": {
        "16": "images/icon_16.png",
        "48": "images/icon_48.png",
        "128": "images/icon_128.png"
    }
}

我的background.js文件只是运行另一个名为work.js

// Respond to the click on extension Icon
chrome.browserAction.onClicked.addListener(function (tab) {
    chrome.tabs.executeScript({
        file: 'work.js'
    });
});

我的扩展程序的主要逻辑是在内部work.js。对于这个问题,我认为这里的内容无关紧要。

我想问的是如何在扩展中使用jQuery。由于我没有使用任何背景页面。我不能只添加jQuery。那么,如何在扩展中添加和使用jQuery?

我尝试从background.js文件中运行jQuery以及我的work.js。

// Respond to the click on extension Icon
chrome.browserAction.onClicked.addListener(function (tab) {
    chrome.tabs.executeScript({
        file: 'thirdParty/jquery-2.0.3.js'
    });
    chrome.tabs.executeScript({
        file: 'work.js'
    });
});

它工作正常,但我担心是否要以异步方式执行添加为以这种方式执行的脚本。如果是,则有可能work.js甚至 jQuery(或将来可能添加的其他库)之前运行。

我还想知道在chrome扩展程序中使用第三方库的正确和最佳方法是什么。


2
正确的方法是去香草!
bjb568 2014年

如果您正在这里寻找如何将jQuery添加到弹出扩展(如我),看到这个问题:stackoverflow.com/questions/12035242/...
临Q

Answers:


124

您必须像这样将jQuery脚本添加到chrome-extension项目和backgroundmanifest.json 的部分中:

  "background":
    {
        "scripts": ["thirdParty/jquery-2.0.3.js", "background.js"]
    }

如果需要在content_scripts中使用jquery,则也必须在清单中添加它:

"content_scripts": 
    [
        {
            "matches":["http://website*"],
            "js":["thirdParty/jquery.1.10.2.min.js", "script.js"],
            "css": ["css/style.css"],
            "run_at": "document_end"
        }
    ]

这就是我所做的。

另外,如果我没记错的话,后台脚本会在您可以通过打开的后台窗口中执行chrome://extensions


7
那么你到底是什么意思You have to add your jquery script to your chrome-extension project?我做到了:manifest.json: "background": { `“ scripts”:[“ thirdParty / jquery-2.0.3.js”,“ background.js”],``persistent“:false``},`我已经下载了jQuery到thirdParty文件夹。但是我仍然不能使用jQuery。它给出了错误:Uncaught ReferenceError: $ is not defined 我将其添加到我的work.js文件中进行测试。 $("body").html("Foo!");
Ishan 2014年

上面的评论看起来一团糟,但是在添加评论时未显示预览。请原谅我。
Ishan 2014年

我的意思是将其添加到您的chrome-extension文件夹中。像/home/you/chromexetension_source_files/thirdParty/jquery-2.0.3.js。您应该对work.js做同样的事情。
Nico 2014年

1
我试着按照你说的做。但是我仍然遇到无法从我的work.js文件访问jquery的错误。Uncaught ReferenceError: $ is not defined。如果可以,可以将工作示例上传到某个地方。只是一个简单的示例,例如执行'$(“ body”)。html(“ Foo!”);' 在work.js中。
伊桑2014年

7
我也有麻烦jQuery$得到认可。原来,我在清单数组中最后引用了jQuery。当我把它放在第一位的时候,它就被认可了。
BenR

18

只需执行以下操作就很容易了:

在manifest.json中添加以下行

"content_security_policy": "script-src 'self' https://ajax.googleapis.com; object-src 'self'",

现在您可以直接从url直接加载jQuery

  <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.2/jquery.min.js"></script>

资料来源:google doc


1
如果要加载多个脚本怎么办?
另一

1
如果您想从远程服务器加载脚本(这实际上要求您使用扩展名和它可以访问的所有内容信任远程服务器),则是一个很好的答案。
纳撒尼尔(Nathaniel Verhaaren)

1
@NathanielVerhaaren这是一个合理的提出要点,但是可以通过使用subresource integrity(SRI)验证源来缓解。
Dan Atkinson

13

它工作正常,但我担心是否要以异步方式执行添加为以这种方式执行的脚本。如果是,则有可能work.js甚至在jQuery(或将来可能添加的其他库)之前运行。

其实不应该担心:您将脚本排队在某个JS上下文中执行,并且该上下文不能具有竞争条件,因为它是单线程的。

但是,消除此问题的正确方法是将调用链接起来:

chrome.browserAction.onClicked.addListener(function (tab) {
    chrome.tabs.executeScript({
        file: 'thirdParty/jquery-2.0.3.js'
    }, function() {
        // Guaranteed to execute only after the previous script returns
        chrome.tabs.executeScript({
            file: 'work.js'
        });
    });
});

或概括地说:

function injectScripts(scripts, callback) {
  if(scripts.length) {
    var script = scripts.shift();
    chrome.tabs.executeScript({file: script}, function() {
      if(chrome.runtime.lastError && typeof callback === "function") {
        callback(false); // Injection failed
      }
      injectScripts(scripts, callback);
    });
  } else {
    if(typeof callback === "function") {
      callback(true);
    }
  }
}

injectScripts(["thirdParty/jquery-2.0.3.js", "work.js"], doSomethingElse);

或者,承诺(并使其更符合正确的签名):

function injectScript(tabId, injectDetails) {
  return new Promise((resolve, reject) => {
    chrome.tabs.executeScript(tabId, injectDetails, (data) => {
      if (chrome.runtime.lastError) {
        reject(chrome.runtime.lastError.message);
      } else {
        resolve(data);
      }
    });
  });
}

injectScript(null, {file: "thirdParty/jquery-2.0.3.js"}).then(
  () => injectScript(null, {file: "work.js"})
).then(
  () => doSomethingElse
).catch(
  (error) => console.error(error)
);

或者,为什么不使用async/ await-ed以获得更清晰的语法:

function injectScript(tabId, injectDetails) {
  return new Promise((resolve, reject) => {
    chrome.tabs.executeScript(tabId, injectDetails, (data) => {
      if (chrome.runtime.lastError) {
        reject(chrome.runtime.lastError.message);
      } else {
        resolve(data);
      }
    });
  });
}

try {
  await injectScript(null, {file: "thirdParty/jquery-2.0.3.js"});
  await injectScript(null, {file: "work.js"});
  doSomethingElse();
} catch (err) {
  console.error(err);
}

请注意,在Firefox中,您只能使用browser.tabs.executeScript它,因为它会返回一个Promise。


第一种方法很棒。作为一个不太了解JavaScript的人,我从未考虑过类似的事情。
FriskySaga

11

除了已经提到的解决方案之外,您还可以jquery.min.js在本地下载然后使用它-

对于下载-

wget "https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"

manifest.json-

"content_scripts": [
   {
    "js": ["/path/to/jquery.min.js", ...]
   }
],

在html中-

<script src="/path/to/jquery.min.js"></script>

参考-https: //developer.chrome.com/extensions/contentSecurityPolicy


3
这是最好的方法...您不需要html部分。
c-

1

就我而言,它通过跨文档消息传递(XDM)和执行Chrome扩展onclick而不是页面加载获得了一个可行的解决方案。

manifest.json

{
  "name": "JQuery Light",
  "version": "1",
  "manifest_version": 2,

  "browser_action": {
    "default_icon": "icon.png"
  },

  "content_scripts": [
    {
      "matches": [
        "https://*.google.com/*"
      ],
      "js": [
        "jquery-3.3.1.min.js",
        "myscript.js"
      ]
    }
  ],

  "background": {
    "scripts": [
      "background.js"
    ]
  }

}

background.js

chrome.browserAction.onClicked.addListener(function (tab) {
  chrome.tabs.query({active: true, currentWindow: true}, function (tabs) {
    var activeTab = tabs[0];
    chrome.tabs.sendMessage(activeTab.id, {"message": "clicked_browser_action"});
  });
});

myscript.js

chrome.runtime.onMessage.addListener(
    function (request, sender, sendResponse) {
        if (request.message === "clicked_browser_action") {
        console.log('Hello world!')
        }
    }
);
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.