Skip to content

Latest commit

 

History

History
111 lines (71 loc) · 3.26 KB

README.md

File metadata and controls

111 lines (71 loc) · 3.26 KB
Raw

nest-next-module

简介

在nestjs中使用nextjs做模板渲染引擎.

由于需求要做SEO, 自然而然的想到了SSR. 在对比Angular Universal, nuxtjs, nextjs之后, 选择了nextjs.

同时发现, nextjs如果要增加动态路由等功能, 需要后台去做支持, 于是选择了typescript支持最完善的nestjs框架.

于是如何将nestjs与nextjs一起使用, 就成了我们主要解决的问题.

在nestjs和nextjs中都包含一个node http的实现, 因此需要将nestjs的页面路由请求, 转发给nextjs去处理渲染模板, 以及一些静态资源的访问也需要做转发.

在nestjs的issues 1122中Kyle McCarthy写了一个nest-next包, 仔细阅读了其源码之后, 我决定自己写一个绑定模块.

原因主要是因为nest-next篡改了nestjs中express中的模板引擎, 侵入性比较强, 如果我还需要用express的模板渲染的话, 是不可能做到的. 其次nest-next的模块导入方式不符合nestjs模块正常使用方式, 需要手动启动next-server并绑定.

注意！

目前nextjs最新版为9.x版本，如果要在9.x版本中使用本模块，请参考：

https://github.com/ananiy/nest-next-module/tree/release/v0.1.8

并使用v0.1.8版本

Demo

nest-next-module-demo

开始使用

  • 安装@nestjs/cli, 新建一个项目:
$ npm i -g @nestjs/cli
$ nest new nest-next-demo # 请选择使用yarn安装模块
  • 安装NestNextModule包, 和nextjs相关依赖:
$ yarn add nest-next-module next react react-dom
  • 在AppModule中导入NestNextModule:
// src/app.module.ts

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { NestNextModule } from 'nest-next-module';

const dev = process.env.NODE_ENV !== 'production';

@Module({
  imports: [NestNextModule.forRoot({ dev })],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}
  • 在AppController中创建路由, 使用nextjs的render渲染模板:
// src/app.controller.ts

import { Controller, Get, Res } from '@nestjs/common';
import { NextResponse } from 'nest-next-module';

@Controller()
export class AppController {
  @Get()
  index(@Res() res: NextResponse) {
    return res.nextRender('/index');
  }
}
  • 根目录新建pages文件夹, 新建index.jsx文件:
// pages/index.tsx

import React from 'react';

const Page = () => {
  return <h1>hello nest next!</h1>;
};

export default Page;
  • 启动项目:
$ yarn start
  • 打开浏览器, 访问http://localhost:3000/.

在nextjs中使用typescript

最新版的nextjs已经内置了ts的支持， 因此可以直接使用ts/tsx

但是到目前为止，nextjs 9.0.x版本会默认覆盖tsconfig.json，并且设置module为esnext，导致nestjs无法编译

所以需要单独新建nestjs的tsconfig文件，改module为commonjs，具体可以参考demo中的配置