Nodejs中怎么样的才算是workflow？你的Nodejs workflow是怎么样的？

Nodejs中怎么样的才算是workflow？你的Nodejs workflow是怎么样的？

目前为止我一直在尝试规范自己的编码习惯，工作习惯，可惜的是一直都还没有定型。

  • 我最熟练的语言是javascript，在规范编码习惯方面我尝试用过设计模式，但实战时总是又… “模糊了界限”… 这样的感觉。一段时间过后，回头看看写的代码，又难于分辨逻辑了。
  • 我曾经尝试过项目管理软件，例如某道，但录入的任务和实际总是有冲突，不知不觉又放弃了。
  • 我尝试过轻量级的番茄钟，就是工作25分钟，休息5分钟的那种，目前还在间隙着用，但总是忘记了时间，25分钟对我来说不够用。

我理解的workflow，不仅是 例如 grunt gulp 之类的工具，而且一整套的流程，思维习惯，不知道这个理解对不对。


4 回复

Node.js 中的 Workflow

在Node.js中，Workflow不仅仅是指使用特定的构建工具（如Grunt或Gulp），而是指整个开发过程中的工作流，包括代码编写、测试、部署等各个阶段的一系列最佳实践。一个良好的Workflow可以帮助团队保持一致性和高效性。

示例 Workflow

以下是一个简单的Node.js Workflow示例，包括项目结构、自动化脚本、持续集成和部署等方面：

1. 项目结构

my-node-app/
├── src/
│   ├── index.js
│   └── utils/
│       └── helper.js
├── tests/
│   └── index.test.js
├── .gitignore
├── package.json
├── .env
├── .eslintrc.json
└── README.md

2. 自动化脚本

使用npm scripts来定义一些常用的命令，比如构建、测试和启动应用。

{
  "name": "my-node-app",
  "version": "1.0.0",
  "scripts": {
    "start": "node src/index.js",
    "build": "tsc",
    "test": "jest",
    "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
  },
  "dependencies": {
    "express": "^4.17.1"
  },
  "devDependencies": {
    "eslint": "^8.15.0",
    "jest": "^29.0.3",
    "typescript": "^4.5.4"
  }
}

3. 持续集成/持续部署 (CI/CD)

使用GitHub Actions或GitLab CI来进行自动化测试和部署。

# .github/workflows/ci.yml
name: CI

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Use Node.js
      uses: actions/setup-node@v3
      with:
        node-version: '16.x'
    - run: npm install
    - run: npm test
    - run: npm run lint

4. 环境变量管理

使用.env文件来管理环境变量，并通过.gitignore忽略它。

# .env
DB_HOST=localhost
DB_USER=root
DB_PASS=s1mpl3

5. 设计模式和代码风格

  • 模块化：将功能拆分为小的模块，便于维护和复用。
  • 单例模式：用于创建全局唯一对象，例如数据库连接池。
  • 工厂模式：用于创建对象，提高代码的可扩展性。
// src/utils/database.js
const mysql = require('mysql');

let connection;

function connect() {
  if (!connection) {
    connection = mysql.createConnection({
      host: process.env.DB_HOST,
      user: process.env.DB_USER,
      password: process.env.DB_PASS
    });
  }
  return connection;
}

module.exports = { connect };

总结

一个良好的Node.js Workflow不仅包含工具的使用，还应包括项目结构、自动化脚本、持续集成和代码风格等方面的规范。这有助于提高开发效率，减少错误，保持代码的整洁和可维护性。


我觉得僵化的流程了才有 Workflow, 比如说人多了需要协作啦, 或者代码框架初始化代码太多了, 于是只好提炼到 workflow 里边去

我觉得你的理解没啥问题，找到适合自己和团队的工作方式，然后把其中流程化的东西用工具自动化提升效率，再不断优化，至于是不是workflow这个不重要

你的理解是正确的，Node.js中的Workflow不仅仅是任务执行工具（如Grunt、Gulp等），而是一整套包括开发、构建、测试、部署等各个环节在内的流程和方法论。

下面我将为你展示一个简单的Node.js Workflow示例，并简要解释每个步骤：

  1. 项目初始化：

    • 创建项目目录并初始化npm。
      mkdir myproject
cd myproject
npm init -y

  2. 依赖安装：

    • 安装所需的包（如Express用于Web服务）。
      npm install express

  3. 编写代码：

    • 创建基本的Express应用。
      // app.js
const express = require('express');
const app = express();
const port = 3000;

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(port, () => {
  console.log(`App listening at http://localhost:${port}`);
});

  4. 配置任务自动化：

    • 使用npm scripts来运行脚本，比如启动应用或进行代码检查。
      // package.json
"scripts": {
  "start": "node app.js",
  "test": "echo \"Error: no test specified\" && exit 1",
  "lint": "eslint ."
}

  5. 代码审查与静态分析：

    • 安装ESLint来检查代码质量。
      npm install eslint --save-dev
    • 配置.eslintrc文件。
      // .eslintrc.json
{
  "env": {
    "browser": true,
    "es6": true
  },
  "extends": "eslint:recommended",
  "rules": {
    "indent": ["error", 2]
  }
}

  6. 单元测试：

    • 使用Mocha和Chai来编写测试。
      npm install mocha chai --save-dev
    • 编写测试文件，比如test/app.test.js。
      const assert = require('chai').assert;
const request = require('supertest');

describe('GET /', function() {
  it('should return 200 OK', function(done) {
    request('http://localhost:3000')
      .get('/')
      .expect(200, done);
  });
});

  7. 持续集成/持续部署（CI/CD）：

    • 配置GitHub Actions或其他CI工具来自动执行上述步骤。
      # .github/workflows/ci.yml
name: CI

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: Use Node.js
      uses: actions/setup-node@v2
      with:
        node-version: '14'
    - run: npm ci
    - run: npm test

  8. 文档生成：

    • 使用JSDoc自动生成API文档。
      npm install jsdoc --save-dev
    • 配置jsdoc.conf.json。
      // jsdoc.conf.json
{
  "source": {
    "include": ["app.js"]
  },
  "plugins": ["plugins/markdown"],
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false
  }
}

  9. 部署：

    • 使用Docker容器化应用，使用Docker Compose或Kubernetes进行部署。
      # Dockerfile
FROM node:14-alpine

WORKDIR /usr/src/app

COPY package*.json ./

RUN npm ci --only=production

COPY . .

CMD [ "node", "app.js" ]

通过上述示例，可以看到一个完整的Node.js Workflow不仅包括了开发环境的搭建，还涵盖了测试、代码审查、CI/CD等环节，从而确保项目的高效与质量。

回到顶部