解决google-play-scraper模块的ERR_REQUIRE_ESM错误

问题背景

在使用google-play-scraper这个Node.js模块时，许多开发者会遇到一个常见的错误：ERR_REQUIRE_ESM。这个错误通常发生在尝试使用require()语法导入ES模块(ESM)格式的包时。在google-play-scraper的10.0.0及以上版本中，模块已经转换为纯ESM格式，不再支持传统的CommonJS(CJS)的require()导入方式。

错误分析

当开发者运行包含以下代码的脚本时：

let gplay = require('google-play-scraper');

系统会抛出ERR_REQUIRE_ESM错误，提示require()不支持导入ES模块。这是因为Node.js对两种模块系统(CommonJS和ESM)的处理方式不同，且不能混用。

解决方案

要解决这个问题，有两种主要方法：

方法一：使用ESM导入语法

1. 将脚本文件中的require语句改为ESM的import语法：

import gplay from "google-play-scraper";
import https from 'https';
import fs from 'fs';

2. 在package.json中添加"type": "module"声明：

{
  "type": "module",
  "dependencies": {
    "google-play-scraper": "^10.0.0"
  }
}

3. 确保文件扩展名为.mjs或者在package.json中声明了模块类型后使用.js扩展名

方法二：使用动态导入

如果必须保持CommonJS格式，可以使用动态import()：

async function getAppData() {
  const gplay = await import('google-play-scraper');
  // 其余代码...
}

完整示例代码

以下是使用ESM格式的完整示例代码，用于从Google Play获取应用图标：

import https from 'https';
import fs from 'fs';
import gplay from "google-play-scraper";

const appIdArray = [
  'com.android.chrome', 
  'com.google.android.googlequicksearchbox'
];

for(let i = 0; i < appIdArray.length; i++) {
  gplay.app({appId: appIdArray[i]})
    .then(function(res) {
      console.log(res);
      let file = fs.createWriteStream(res.appId + ".png");
      let request = https.get(res.icon, function(response) {
        response.pipe(file);
      });
    }).catch(function(err) {
      console.error(err);
    });
}

注意事项

1. 使用ESM格式时，文件路径引用需要使用完整路径(包括文件扩展名)
2. __dirname和__filename在ESM中不可用，需要使用import.meta.url替代
3. 某些Node.js内置模块的命名导入方式可能略有不同
4. 如果项目中有其他CommonJS模块，可能需要统一转换为ESM或使用动态导入

总结

随着Node.js生态向ES模块的迁移，越来越多的包开始仅支持ESM格式。google-play-scraper从10.0.0版本开始转为纯ESM包，开发者需要相应调整代码结构以适应这一变化。通过正确使用ESM导入语法或动态导入，可以轻松解决ERR_REQUIRE_ESM错误，继续使用这个强大的Google Play数据抓取工具。