在 Next.js 中使用 Nodemailer 时无法解析 child_process

Question

在 pages/api 路由之一中使用 nodemailer 会产生以下错误消息：

[ error ] ./node_modules/nodemailer/lib/sendmail-transport/index.js Module not found: Can't resolve 'child_process' in 'C:\ua-demo\node_modules\nodemailer\lib\sendmail-transport'

根据我的理解，next.js pages/api 路由运行仅在服务器环境中，很奇怪会发生此错误。如何解决这个问题，以便我可以向我的用户发送电子邮件更新？

已在 codesandbox.io 处添加了一个示例。我认为我们需要直接在本地机器上构建程序的副本才能重现。

Nextjs issue discussion

Answer 1

我找到了来源。使用 Next.js 时，所有模块（包括在构建期间解析本机服务器资源的 NPM 包）都需要在仅服务器端模块中导入。这并不像在通用 Web 应用程序中听起来那么简单。

在一个普遍使用的模块中做类似下面的人为的例子会导致这样的错误：Can't resolve 'child_process' in 'C:\ua-demo\node_modules\nodemailer\lib\sendmail-transport' 因为 child_process 是本机服务器资源。

// send-mail/server.js
import nodeMailer from 'nodemailer';
import config from './some/nodemailer/config;

const transport = nodeMailer.createTransport( config );
const sendMail = message => transport.sendMail( message );

export default sendMail;

// send-mail/browser.js
import { post } from 'axios';

const sendMail = async ( axiosRequestConfig ) => {
    try {
        await post( axiosRequestConfig );
    } catch( e ) {
        console.error( e );
    }
};
export default sendMail;

// send-mail/index.js
import isBrowser from './some/browser/detection/logic';
import browserMailer from './browser';
import serverMailer from './server';

const mailer = isBrowser() ? browserMailer : serverMailer;

export default mailer;

将此 'send-mail' 模块导入到您的组件中，相信浏览器检查可确保在运行时有适当的发送电子邮件逻辑。但是，构建失败并出现与上述类似的错误。这里的解决方案是修改 send-mail 模块以将其导入推迟到运行时。

// send-mail/index.js
import dynamic from 'next/dynamic'; // Can also use other lazy-loading module mechanism here. Since we are building a next.js app here, why not use the one created specifically for next apps?
import isBrowser from './some/browser/detection/logic';

const mailer = isBrowser()
    ? dynamic(() => import( './server' ))
    : dynamic(() => import( './browser' ));

export default mailer;

如果使用 webpack，我们可以为客户端构建设置 RUN_TARGET=BROWSER 环境变量，并使用 webpack-conditional-loader 在构建时分支代码，而不是动态运行时加载，如：

// #if process.env.RUN_TARGET !== 'BROWSER'
import serverMailer from './server';
// #endif
// #if process.env.RUN_TARGET === 'BROWSER'
import browserMailer from './browser';
// #endif
let mailer;
// #if process.env.RUN_TARGET !== 'BROWSER'
mailer = serverMailer;
// #endif
// #if process.env.RUN_TARGET === 'BROWSER'
mailer = browserMailer;
// #endif

export default mailer;

// yeilds the following after server-side build
import serverMailer from './server';
let mailer;
mailer = serverMailer;
export default mailer;

// yeilds the following after client-side build
import browserMailer from './browser';
let mailer;
mailer = browserMailer;
export default mailer;

也可以选择删除 index.js 分支，并在仅服务器端模块中手动导入服务器电子邮件逻辑，在仅浏览器模块中手动导入浏览器电子邮件逻辑。在大型应用程序中，即使不是不可能处理，这也会变得非常麻烦。不建议手动执行此操作。

Answer 2

在我的例子中，我导入了一个看似只有客户端代码的简单方法：

import { clientSideMethod } from 'mypackage'

clientSideMethod() 位于：

./node_modules/mypackage/dist/utils.js

但是错误来自一个完全不同的文件：

Module not found: Can't resolve 'child_process'
error - ./node_modules/mypackage/dist/file.js:8:0

似乎使用通用包导入，遍历下面的所有文件，而不管这些方法是否实际被调用：

import { clientSideMethod } from 'mypackage'

实际上首先进入包的根目录并调用：

export * from './file'; // contains server-side code
export * from './utils'; // contains client-side code only

因此触发了错误。解决方案，上面已经提到了一些是：

使用更具体的导入 import { clientSideMethod } from '../../node_modules/mypackage/dist/utils'
需要时动态导入服务器端模块
将包或模块拆分为客户端与服务器端

修复起来非常简单，但找到原因却令人沮丧！

在 Next.js 中使用 Nodemailer 时无法解析 child_process

Can't resolve child_process when using Nodemailer in Next.js

child-process

nodemailer

react-redux

next.js