electron-builder打包Electron应用生产环境路径配置与日志最佳实践

开发环境下的相对路径data/logs能正常生效，是因为开发时进程的工作目录就是项目根目录；但打包后应用的安装目录（含Resources、Contents下的路径，哪怕在asar包外部）是系统保护的只读区域，普通用户没有写入权限，且进程的工作目录会随系统启动位置变化，相对路径会完全失效。

正确的路径规则：

• 禁止往应用安装目录（Resources、Contents根目录、asar包内部）写日志，这类区域直接写入会触发权限报错，甚至被系统安全软件拦截
• 优先选择Electron官方分配的用户专属可写目录：通过app.getPath('userData')获取当前系统下当前用户的应用专属存储目录，该目录为Electron官方推荐的应用持久化数据存储位置，权限完全可控，不会被系统自动清理。Windows下路径示例为C:\Users\[用户名]\AppData\Roaming\应用名称，macOS下为~/Library/Application Support/应用名称，Linux下为~/.config/应用名称
• 可搭配环境判断逻辑兼容开发、生产两套环境的路径差异，对应的winston配置示例：

const { app } = require('electron');
const path = require('path');
const winston = require('winston');

// 自动区分开发/生产环境的日志根路径
const logRootDir = app.isPackaged
  ? path.join(app.getPath('userData'), 'logs')
  : path.join(process.cwd(), 'data/logs');

// 初始化错误日志写入实例
const errorLoggerTransport = new winston.transports.File({
  filename: path.join(logRootDir, 'error.log'),
  level: 'error'
})

如果需要让用户手动查找日志、导出日志，也可以选择app.getPath('documents')下新建专属日志目录，但这类目录容易被用户误删，优先级低于userData目录。

• 路径获取全程依赖Electron提供的系统API，不要硬编码写死绝对路径，避免跨系统、跨版本的路径不兼容问题
• 做日志拆分分级存储：不同日志级别单独存文件（比如error.log仅存错误日志、combined.log存全量运行日志），减少排查问题时的无效信息检索成本
• 接入日志轮转能力：使用winston生态的winston-daily-rotate-file组件，按天/按单文件大小阈值自动分割日志，自动清理超出保留周期的旧日志，避免日志无限增长占用用户磁盘空间
• 生产环境做日志脱敏：日志输出前过滤掉用户隐私信息、接口鉴权密钥、密码等敏感内容，规避合规风险
• 内置日志快捷入口：在应用设置页增加"打开日志目录"的功能，调用shell.openPath(logRootDir)直接唤起系统文件管理器打开日志所在位置，降低用户反馈问题时的日志收集成本
• 生产环境关闭冗余的控制台日志输出：避免主进程/渲染进程的冗余控制台日志带来的性能损耗
• 不要尝试把日志写入应用安装目录：这类受系统保护的只读区域，不仅会触发权限报错，还可能被系统安全软件判定为异常写入行为

内容的提问来源于stack exchange，提问作者miltone