Node ORM2 教程：入门与配置

Node ORM2 教程：入门与配置

1. 项目目录结构及介绍

Node ORM2 的目录结构通常包含以下几个主要部分：

node-orm2/
│
├── index.js        # 主入口文件，包含ORM的核心功能
├── lib/             # 存放核心库代码
│   ├── Model.js     # 模型类定义
│   ├── Instance.js  # 实例管理
│   └── ...           # 其他相关类和模块
├── examples/        # 示例代码
├── test/            # 单元测试
└── ...

lib/ 目录下的文件是 ORM 功能实现的关键，包括模型（Model）、实例（Instance）等核心组件。examples/ 目录提供了如何使用 ORM 的简单示例，而 test/ 目录则包含了对 ORM 各个功能的单元测试。

2. 项目的启动文件介绍

在 Node.js 应用中，初始化并使用 Node ORM2 通常是通过以下步骤进行的：

// 加载 ORM 库
const orm = require('orm');

// 连接数据库（以MySQL为例）
orm.connect('mysql://username:password@localhost/dbname', function (err, db) {
  if (err)
    throw err;

  // 定义一个模型
  db.define('user', {
    name: String,
    email: { type: 'text', unique: true },
    data: 'json'  // JSON类型的数据
  });

  // 开始操作数据库
  db.sync(function () {
    console.log('Database synced!');
    
    // 使用模型创建数据
    db.models.user.create({ name: 'John Doe', email: 'john@example.com' }, function(err, user) {
      if (err) throw err;
      
      console.log(user);
    });
  });
});

在上述代码中，orm.connect() 是连接数据库的起点，db.define() 用于定义模型，db.sync() 用于同步数据库表结构，最后的例子展示了如何创建新记录。

3. 项目的配置文件介绍

虽然 Node ORM2 可以在运行时直接传递数据库连接字符串，但在实际项目中，为了提高可维护性和避免硬编码敏感信息，推荐将配置放入单独的文件，如 config.js：

module.exports = {
  development: {
    host: 'localhost',
    user: 'dev_user',
    password: 'dev_password',
    database: 'dev_db'
  },

  production: {
    host: process.env.PROD_HOST,
    user: process.env.PROD_USER,
    password: process.env.PROD_PASSWORD,
    database: process.env.PROD_DB
  }
};

然后，在主应用中引入配置文件：

const config = require('./config')[process.env.NODE_ENV || 'development'];

orm.connect(`mysql://${config.user}:${config.password}@${config.host}/${config.database}`, function (err, db) {
  //...其他操作
});

这样可以根据环境变量选择不同的数据库配置，更方便地管理多个环境（例如开发、生产环境）的数据库连接。

请注意，这只是一个基础示例，真实项目可能还会涉及其他的配置选项，如连接池、日志设置等。详细配置项可以参考 Node ORM2 的官方文档。