介绍 Plankton

04/30/2024 18:43:41 | China Standard Time

Plankton 是一个简单，快速，零依赖的 Node.js Web 框架，借鉴了 ASP.NET 的许多特点，如果你是一个 .NET 开发者，应该可以很快的上手 Plankton。这个框架的目标是得到一个轻量的，功能尽量齐全，且可定制的 web 框架用来搭建一些自用的服务。这篇文章会简单的介绍下 Plankton v0.2.5 的基本用法。

# Plankton

![NPM Version](https://img.shields.io/npm/v/%40lixinyang123%2Fplankton) ![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/%40lixinyang123%2Fplankton) [![CI](https://github.com/lixinyang123/Plankton/actions/workflows/ci.yml/badge.svg)](https://github.com/lixinyang123/Plankton/actions/workflows/ci.yml)

[Plankton](https://github.com/lixinyang123/Plankton) is a simple, fast, zero-dependency web framework for Node.js

#### Features

- Simple
- Fast
- Zero-dependency
- Small size
- Support mvc
- Built-in template engine

## Install

This is a [Node.js](https://nodejs.org/) module available through the [npm](https://www.npmjs.com/).

```bash
npm install @lixinyang123/plankton
# or
yarn add @lixinyang123/plankton
```

## Quick Start

You need create a nodejs project first.

```bash
yarn init
yarn add @lixinyang123/plankton
mkdir src
touch src/main.js
```

copy this code to `src/main.js`.

```javascript
import plankton from '@lixinyang123/plankton'

plankton()
    .map('/', (req, res) => {
        res.end('hello world')
    })
    .build()
    .start()
```

Finally, you can launch your first web app.

```bash
node src/main.js
curl localhost:8080
```

## Usage

Here are some basic usages,  You can find more in the [example](https://github.com/lixinyang123/Plankton/tree/main/example) folder.

#### Basic

```javascript
plankton().map('/', (req, res) => {
    res.end('hello world')
}).build().start()
```

#### Group

```javascript
plankton().mapGroup('api', group => {
    group.map('/', (req, res) => {
        res.end('hello world')
    })
}).build().start()
```

#### Middleware

- src/main.js

```javascript
import plankton from '@lixinyang123/plankton'
import TestMiddleware from './middlewares/test.js'

let app = plankton()

app.use(async (req, res, next) => {
    console.log('middleware 1 start')
    await next(req, res)
    console.log('middleware 1 end')
})

app.use(TestMiddleware)

app.map('/', (req, res) => {
    res.end('hello world')
})

app.build().start()
```

- src/middlewares/test.js

```javascript
export default async function (req, res, next) {
    res.write('middleware 2 start')
    await next(req, res)
    res.write('middleware 2 end')
}
```

`curl localhost:8080`, You can see the output

```bash
middleware 1 start
middleware 2 start
middleware 2 end
middleware 1 end
```

#### MVC

- src/main.js

```javascript
plankton()
    .mapController()
    .build()
    .start()
```

- src/controllers/home.js

```javascript
export default {
    index: async (req, res) => {
        await res.render('index.ejs', { action: 'index' })
    },

    about: async (req, res) => {
        await res.render('about.ejs', { action: 'about' })
    }
}
```

- src/views/index.ejs

```html
<body>
    <h1>Hello world from action: <%= action %></h1>
</body>
```

#### Layout

- src/views/_layout.ejs

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Example</title>
</head>
<body>
    <header>Header</header>
        <%{{ content }}%>
    <footer>Footer</footer>
</body>
</html>
```

- src/views/home/index.ejs

```html
<%{ '../_layout.ejs' }%>

<%{ content %>
    <div>
        <% for (let i = 0; i < 5; i++) { %>
            <h1>Hello <%= world %></h1>
        <% } %>
    </div>
<%} %>
```

- src/main.js

```javascript
plankton().map('/', async (req, res) => {
    await res.render('index.ejs', { world: 'world' })
}).build().start()
```

#### StaticFile

```javascript
let app = plankton()

// map static file
app.useStaticFile()
app.useStaticFile('static', 'test')

app.map('/', (req, res) => {
    res.redirect('/index.html')
})

app.build().start()
```

#### Cors

```javascript
plankton()
    .useCors()
    .map('/', (req, res) => {
        res.end('hello world')
    }).build().start()
```

#### Logger

```javascript
plankton()
    .useLogger((msg, level) => {
        // handler...
    })
    .map('/', (req, res) => {
        res.end('hello world')
    }).build().start()
```

#### Cookie

```javascript
plankton()
    .map('/', (req, res) => {
        res.cookie('hello', 'world')
        res.end('hello world')
    })
    .map('/test', (req, res) => {
        res.end('hello ' + req.cookie['hello'])
    })
    .build()
    .start(8080)
```

> res.cookie(key, value, expires, path)

#### Session

```javascript
plankton()
    .useSession(/* 1000 * 5 */)
    .map('/', (req, res) => {
        res.session.set('hello', 'world')
        res.end('hello world')
    })
    .map('/test', (req, res) => {
        res.end('hello ' + req.session.get('hello'))
    })
    .build()
    .start(8080)
```

> default session expires is 30 mins

TOP