在构建基于 Express.js
和 better-sqlite3
的应用时,遵循一些最佳实践可以帮助你更高效地管理数据库连接、提高代码的可读性和可维护性,并确保应用的安全性和性能。以下是一些详细的建议和示例代码。
一、数据库连接管理
1. 单例模式管理数据库连接
创建一个单独的文件来初始化和导出数据库实例,确保在整个应用程序生命周期内只打开一次数据库连接。
javascript
// db.js
const Database = require('better-sqlite3');
const db = new Database('path/to/database.db', { verbose: console.log });
module.exports = db;
2. 中间件集成
通过中间件将数据库对象挂载到请求对象上,简化路由处理函数中的数据库访问。
javascript
// middleware/db.js
const db = require('../db');
module.exports = (req, res, next) => {
req.db = db;
next();
};
在主应用文件中使用该中间件:
javascript
const express = require('express');
const dbMiddleware = require('./middleware/db');
const app = express();
app.use(express.json());
app.use(dbMiddleware);
二、使用事务
对于需要保证数据一致性的操作,使用事务可以避免部分更新导致的数据不一致问题。
javascript
// 在某个服务函数中
const transaction = db.transaction((userId, name) => {
const insertStmt = db.prepare('INSERT INTO users (id, name) VALUES (?, ?)');
insertStmt.run(userId, name);
});
try {
transaction(1, 'John Doe');
} catch (err) {
console.error('Transaction failed:', err.message);
}
三、预编译语句(Prepared Statements)
使用预编译语句不仅能提升性能,还能有效防止SQL注入攻击。
javascript
// 在某个路由处理器中
const stmt = db.prepare('SELECT * FROM users WHERE id = ?');
const user = stmt.get(req.params.id);
if (user) {
res.json(user);
} else {
res.status(404).send({ message: 'User not found' });
}
四、错误处理
对所有数据库操作进行适当的错误处理,确保即使发生错误也能提供清晰的信息或采取适当的恢复措施。
javascript
app.post('/users', (req, res) => {
try {
const stmt = db.prepare('INSERT INTO users (name, email) VALUES (?, ?)');
stmt.run(req.body.name, req.body.email);
res.status(201).send({ message: 'User created' });
} catch (err) {
console.error('Error inserting new user:', err.message);
res.status(500).send({ message: 'Internal Server Error' });
}
});
五、关闭数据库连接
尽管大多数情况下不需要显式关闭 better-sqlite3
的数据库连接,但在某些特殊情况下(如长时间不活动或在多进程环境中),考虑在适当的时候关闭数据库连接以优化资源使用。
1. 监听退出信号
在应用退出前关闭数据库连接是一个好的做法,特别是当你有其他资源需要释放时。可以使用 Node.js 的 process
事件来监听退出信号并关闭数据库连接。
javascript
function handleShutdown(signal) {
console.log(`Received ${signal}. Closing database connection.`);
db.close();
process.exit(0);
}
process.on('SIGINT', handleShutdown);
process.on('SIGTERM', handleShutdown);
2. 中间件模式中的关闭
如果你使用中间件模式来管理数据库连接,确保在应用程序关闭时能够正确关闭数据库连接:
javascript
// middleware/db.js
const Database = require('better-sqlite3');
const db = new Database('path/to/database.db');
module.exports = (req, res, next) => {
req.db = db;
next();
};
// 在应用的入口文件中添加关闭逻辑
const dbMiddleware = require('./middleware/db');
const db = require('./db'); // 如果你在单独的文件中初始化了db
function handleShutdown(signal) {
console.log(`Received ${signal}. Closing database connection.`);
db.close();
process.exit(0);
}
process.on('SIGINT', handleShutdown);
process.on('SIGTERM', handleShutdown);
app.use(dbMiddleware);
六、测试与维护
编写单元测试:
为您的数据库交互逻辑编写单元测试,确保其按预期工作。
javascript
const assert = require('assert');
const db = require('./db');
describe('Users', function() {
it('should insert a user', function() {
const stmt = db.prepare('INSERT INTO users (name, email) VALUES (?, ?)');
stmt.run('Test User', '[email protected]');
const user = db.prepare('SELECT * FROM users WHERE email = ?').get('[email protected]');
assert.strictEqual(user.name, 'Test User');
});
});
定期备份数据库:
定期备份数据库,并考虑实现自动化的备份策略。监控数据库性能,必要时优化查询或调整索引。
总结
通过遵循上述最佳实践,你可以构建出既安全又高效的基于 Express.js
和 better-sqlite3
的应用。以下是关键点:
- 单一实例管理数据库连接:确保在整个应用程序生命周期内只打开一次数据库连接。
- 使用事务:保证数据一致性,避免部分更新导致的数据不一致问题。
- 预编译语句:提高性能并防止SQL注入攻击。
- 错误处理:对所有数据库操作进行适当的错误处理,确保即使发生错误也能提供清晰的信息或采取适当的恢复措施。
- 关闭数据库连接:在特定情况下(如应用退出时)关闭数据库连接,避免潜在的资源泄漏。
- 测试与维护:编写单元测试,定期备份数据库,并监控性能。
希望这些最佳实践能帮助你在构建高效、可靠的 Web 应用时做出更好的决策。如果有任何进一步的问题或具体场景的需求,请随时提问!