如何将KnexJS字符编码改为utf8mb4以解决键过长错误？

这个问题我之前也碰到过，本质是utf8mb4编码下每个字符占4字节，Knex默认的varchar(255)计算下来是255×4=1020字节，超过了MySQL InnoDB默认的索引最大长度767字节，所以触发了ER_TOO_LONG_KEY错误。

你有两种可行的解决方式，不用每次都手动写191：

1. 全局配置Knex（推荐） #

你可以在Knex的配置文件里一次性设置两个关键项：连接字符集为utf8mb4，同时把全局默认字符串长度改成191。这样所有新建的table.string()都会自动用varchar(191)，不用逐个字段修改。

示例配置（比如knexfile.js）：

module.exports = {
  client: 'mysql2',
  connection: {
    host: '127.0.0.1',
    user: 'your_db_user',
    password: 'your_db_password',
    database: 'your_db_name',
    charset: 'utf8mb4' // 强制连接使用utf8mb4编码
  },
  // 设置全局默认字符串长度为191
  schema: {
    defaultStringLength: 191
  },
  // 其他配置（连接池、迁移表等）
  pool: {
    min: 2,
    max: 10
  },
  migrations: {
    tableName: 'knex_migrations'
  }
};

配置完成后，你原来的创建表代码就可以正常运行了：

db.schema.createTable('testtable', table => { 
  table.increments('id'); 
  table.string('foo').unique(); 
});

2. 手动指定单个字段长度 #

如果不想全局修改默认值，也可以在定义字段时显式指定长度为191，这也是有效的：

db.schema.createTable('testtable', table => { 
  table.increments('id'); 
  table.string('foo', 191).unique(); // 手动设置长度
});

额外注意事项 #

• 确保你的数据库和表本身的字符集也是utf8mb4：Knex的connection.charset配置会在创建表时自动设置表的字符集，但如果是现有数据库，可能需要手动修改库/表的字符集。
• 如果你用的是MySQL 5.7.7+或者MariaDB 10.2.2+，可以开启innodb_large_prefix参数，这样索引最大长度可以提升到3072字节，此时varchar(255)在utf8mb4下（255×4=1020）就不会超过限制了。不过开启这个需要修改MySQL配置，适合有服务器权限的场景。

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