NestとReactを使った簡易版twitterの作成-バックエンド編
1.開発準備
2.今回作るアプリの仕様
3.ディレクトリ、ファイル
4.entity の作成
5.repository の作成
6.NestJS の下準備
7.controller の作成
8.DTO の作成
9.Service の作成
10.動作確認
11.CORS の設定
12.最後に
開発準備
はじめに
ここではバックエンド編の作成に取り組んでいきます。取り組む際、コードを完全に理解する必要ありません！今回はWEBアプリケーションの作成に慣れてもらうことが目的になります。動くものを完成させることが大事です。DONE IS BETTER THAN PERFECT ってザッカーバーグも言ってます。
質問は受け付けます。Slack で質問お願いします。
TablePlus(データベース管理ソフトウェア)のインストール
起動
起動を待つ(ターミナルに「Nest application successfully started 」と表示が出れば ok、結構時間がかかります)
twitter_api コンテナ内
-
docker desktop を開き、twitter_api のコンテナを開く
-
twitter_api コンテナ内で、以下のコマンドを叩く
npm i -g @nestjs/cli ts-node
npm install wordpress-hash-node
今回作るアプリの仕様
作るもの：簡易版 Twitter
機能一覧
- ユーザー登録機能
→氏名、メールアドレス、パスワードをデータベースに挿入 + 簡単なバリデーション - ログイン機能
→メールアドレスとパスワードの組みを送信してその組みがデータベース上に存在するか確認 - ツイート投稿機能
→ツイート投稿(140字以内) - ツイート表示機能
→最新のものを最大100件取得 - ツイート検索機能
→ツイート本文から任意の文字列で部分検索、取得
テーブル定義
| users |
|---|
| id |
| name |
| password |
| accessed_at |
| tweets |
|---|
| id |
| content |
| created_at |
| user_id |
ディレクト、リファイル
今回の backend のディレクトリ構造は、このようになっています。
src
├── app.controller.ts
├── app.module.ts
├── app.service.ts
├── entity
│ ├── tweet.entity.ts
│ └── user.entity.ts
├── main.ts
├── ormconfig.ts
├── repository
│ ├── tweet.repository.ts
│ └── user.repository.ts
├── tweet
│ ├── dto
│ │ ├── request.ts
│ │ └── response.ts
│ ├── tweet.controller.ts
│ ├── tweet.module.ts
│ └── tweet.service.ts
└── user
├── dto
│ ├── request.ts
│ └── response.ts
├── user.controller.ts
├── user.module.ts
└── user.service.ts
entity の作成
-
entity って？
データベースにおけるテーブルの役割。今回は TypeScript のクラス + TypeORM(後述)の書き方で書きます -
ディレクトリの作成
backend/src/ に「entity」という名前でディレクトリを作成してください。 -
ファイルの作成
backend/src/entity 内に「user.entity.ts」「tweet.entity.ts」の二つを作成して下さい。 -
backend/src/entity/user.entity.ts に下のコードをコピー(エラーが出ても気にしないでください)して下さい。
import {
Entity,
PrimaryGeneratedColumn,
Column,
OneToMany,
} from 'typeorm';
import { Tweet } from './tweet.entity';
@Entity('users')
export class User {
//データベースでいうautoincrement(主キー)
@PrimaryGeneratedColumn({ type: 'integer', name: 'id' })
id!: number;
@Column('character varying', { name: 'name' })
name: string;
@Column('character varying', { name: 'password' })
password: string;
//unique設定をしている
@Column('character varying', { name: 'email', unique: true })
email: string;
//デフォルト値をnullに
@Column({
name: 'accesses_at',
type: 'timestamp without time zone',
default: null,
})
accessedAt: Date | null;
//1対多の関係の記述、カスケードの記述(多対1の関係では記述方法が異なるので注意)
@OneToMany(() => Tweet, (tweet) => tweet.user, {
cascade: ['insert', 'update', 'remove'],
})
userTweetList: Tweet[];
constructor(
name: string,
password: string,
email: string,
accessedAt: Date | null,
) {
this.name = name;
this.password = password;
this.email = email;
this.accessedAt = accessedAt;
}
}
4. backend/src/entity/tweet.entity.ts に下のコードをコピー(エラーが消えるはずです)して下さい。
import {
Entity,
PrimaryGeneratedColumn,
Column,
CreateDateColumn,
JoinColumn,
ManyToOne,
} from 'typeorm';
import { User } from './user.entity';
@Entity('tweets')
export class Tweet {
@PrimaryGeneratedColumn({ type: 'integer', name: 'id' })
id!: number;
@Column('character varying', { name: 'content' })
content: string;
//レコードを挿入したときに、勝手にその時の時間を入れてくれる
@CreateDateColumn({
name: 'created_at',
type: 'timestamp without time zone',
})
createdAt!: Date;
//多対1の関係、カスケードの記述
@ManyToOne(() => User, (user) => user.userTweetList, {
onDelete: 'CASCADE',
onUpdate: 'CASCADE',
nullable: false,
})
@JoinColumn([{ name: 'user_id', referencedColumnName: 'id' }])
readonly user: User;
constructor(content: string, user: User) {
this.content = content;
this.user = user;
}
}
解説
今回は TypeORM という ORM を用いてバックエンドを書いていきます。詳しくは説明しませんが、データベースとのやりとりをいい感じにやってくれるものという認識で大丈夫です。具体的に言うと、SQLを書かなくてもデータベースにアクセスできたりします。(裏ではSQLが走ってます)上のコードでは TypeORM の書き方でデータベースのテーブルを定義しています。@~~Columnで定義されたものがテーブルのカラムになっているので、上のテーブル定義と見比べてみてください。リレーションの指定も出来て、ここでは＠OneToMany, ＠ManyToOneを用いた一対多の関係を記述しています。
TablePlusの接続
-
TablePlusを開いて、create a new connectionを選択
-
PostgreSQL → createを選択
-
下記の接続情報を入力してください(他はいじらないでください)
|項目|値|
|:-----|:----:|
|Name|twitter|
|Port|5432|
|User|postgres|
|Password|postgres|
|Database|twitter| -
上を入力後、Connectを押してください。画面が切り替わり、左側に先ほど作ったentity通りのテーブルが作成されているはずです。実際に、TypeORMのmigrationという機能で、entityを元にテーブルを自動生成しています。(SQLを書かなくてもテーブルを作成できた！)今回はentityに記載されたコードを元に自動でテーブルが生成・更新される設定にしています。TablePlusからデータの追加や更新もできますが、今回は使わずに確認用にしてください。
repository の作成
-
repository って？
データベースとの接続情報を記述しています。テーブルごとに作成することになります。SQL を使う場合は、ここに記述します。 -
ディレクトリの作成
backend/src/ に「repository」という名前でディレクトリを作成してください。 -
ファイルの作成
backend/src/repository/ に「user.repository.ts」「tweet.repository.ts」の両方を作成してください。 -
backend/src/repository/user.repository.ts に下記のコードをコピーして下さい。
import { Injectable } from '@nestjs/common';
import { DataSource, Repository } from 'typeorm';
import { User } from '../entity/user.entity';
@Injectable()
export class UserRepository extends Repository<User> {
constructor(public dataSource: DataSource) {
super(User, dataSource.createEntityManager());
}
}
5. backend/src/repository/tweet.repository.ts に下記のコードをコピーして下さい。
import { Injectable } from '@nestjs/common';
import { DataSource, Repository } from 'typeorm';
import { Tweet } from '../entity/tweet.entity';
@Injectable()
export class TweetRepository extends Repository<Tweet> {
constructor(public dataSource: DataSource) {
super(Tweet, dataSource.createEntityManager());
}
}
解説
そんなにrepositoryをいじることはないです。難しそうな書き方をしてますが、普通に使う分には理解する必要はないので大丈夫です。ただ、ここに必要であればSQLを記述するということを知っておいてください
nestjs の下準備
今まではTypeORMに関する記述を行ってきました。ここから先はNestJSに関する記述を行っていきます。事前学習で学んでもらった通り、NestJSには「Service」「Controller」「Module」の3つの重要な要素があります。このパートではこの3つのベースとなるファイルをnest/cliを使って作成していきます。
- twitter_api コンテナの中に入ってください
-
docker desktop を開き、twitter_api のコンテナを開く
-
twitter_api コンテナ内で、以下のコマンドを叩く
- Module の作成
コンテナ内で下記のコマンドを実施する(少し時間がかかります)
nest g mo user --no-spec
nest g mo tweet --no-spec
3. Controller の作成
コンテナ内で下記のコマンドを実施する(少し時間がかかります)
nest g co user --no-spec
nest g co tweet --no-spec
4. Service の作成
コンテナ内で下記のコマンドを実施する(少し時間がかかります)
nest g s user --no-spec
nest g s tweet --no-spec
確認
backend/srcディレクトリ内にuserディレクトリとtweetディレクトリが自動作成されていることを確認してください。それぞれのディレクトリにcontroller, module, serviceの3つのファイルが生成されていたら成功です。もしもうまくいっていなければ、自動作成されたディレクトリを削除して、やり直してください。
解説
nest/cliのコマンドを用いてディレクトリとファイルを作成しました。もちろん手動でやってもいいのですが、コマンドを使うことでファイル同士の依存関係も自動で記述してくれます。例えば、userディレクトリ内のuser.module.tsを見てみると、UserServiceとUserControllerを勝手にインポートしてくれています。また、各Moduleをルートモジュール(app.module.ts)に自動登録してくれています。
controller の作成
このパートではcontrollerの基礎となる部分を作成していきます。controllerの主な役割はルーティングでした。他にも、各種パラメーターの記述や、リクエストとレスポンスの型定義などを行うことができます。ここでは最低限のルーティングのみを記述していきます。
- UserController の作成
backend/src/user/user.controller.ts に下記のコードを丸ごとコピーしてください。
import { Controller, HttpCode, Post } from '@nestjs/common';
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
import { UserService } from './user.service';
//@Controller()と@Post()の引数でルーティングを記述
@ApiTags('users')
@Controller('users')
export class UserController {
//UserService を使うための記述
constructor(private readonly userService: UserService) {}
@ApiOperation({ summary: '新規登録' })
@ApiResponse({ status: 200 })
@HttpCode(200)
@Post('create')
async createUser(): Promise<any> {
return {};
}
@ApiOperation({ summary: 'ログイン' })
@ApiResponse({ status: 200 })
@HttpCode(200)
@Post('login')
async login(): Promise<any> {
return {};
}
}
2. TweetController の作成
backend/src/tweet/tweet.controller.ts に下記のコードを丸ごとコピーしてください。
import { Controller, Get, HttpCode, Post } from '@nestjs/common';
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
import { TweetService } from './tweet.service';
//@Controller()と@Post()の引数でルーティングを記述
@ApiTags('tweets')
@Controller('tweets')
export class TweetController {
//TweetServiceを使うための記述
constructor(private readonly tweetService: TweetService) {}
@ApiOperation({ summary: 'ツイート取得' })
@ApiResponse({ status: 200 })
@HttpCode(200)
@Get()
async getTweet(): Promise<any[]> {
return [];
}
@ApiOperation({ summary: 'ツイート投稿' })
@ApiResponse({ status: 200 })
@HttpCode(200)
@Post()
async postTweet(): Promise<any> {
return;
}
@ApiOperation({ summary: 'ツイート検索' })
@ApiResponse({ status: 200 })
@HttpCode(200)
@Post('search')
async searchTweet(): Promise<any[]> {
return;
}
}
解説
このコードでちゃんと書かれているのはルーティングとHTTPメソッドのみになります。エンドポイントに関しては、＠Controller(), ＠Post(), ＠Get()の引数で指定しています。例えば、ユーザー新規登録のエンドポイントは/users/createになっています。HTTPメソッドに関しては、＠Get(), ＠Post()でGETとPOSTを指定しています。今回は利用していませんが、当然PUT, DELETE等も利用できます。
dto の作成
DTO とは端的に説明すると、変数の型を集めたものです。今回は API のリクエストとレスポンスの型定義を行っていきます。同時に、class-validator を用いてバリデーションを行ってきます。
※バリデーションとは、入力されたデータが正しい形式であるかどうかを検証するプログラムのことです。
- ディレクトリ、ファイルの作成
tweet ディレクトリ内と user ディレクトリ内の両方に dto ディレクトリを作成し、その中に 2 つのファイル「request.ts」「response.ts」を作成してください。 backend/src のディレクトリ構成は下記のようになるはずです。
src
├── app.controller.ts
├── app.module.ts
├── app.service.ts
├── entity
│ ├── tweet.entity.ts
│ └── user.entity.ts
├── main.ts
├── ormconfig.ts
├── repository
│ ├── tweet.repository.ts
│ └── user.repository.ts
├── tweet
│ ├── dto
│ │ ├── request.ts
│ │ └── response.ts
│ ├── tweet.controller.ts
│ ├── tweet.module.ts
│ └── tweet.service.ts
└── user
├── dto
│ ├── request.ts
│ └── response.ts
├── user.controller.ts
├── user.module.ts
└── user.service.ts
2. User 用 dto 作成(リクエスト)
backend/src/user/dto/request.ts に下記のコードをコピーして下さい。
import { ApiProperty } from '@nestjs/swagger';
import { IsString, IsNotEmpty, IsEmail } from 'class-validator';
export class CreateUserDTO {
@ApiProperty()
@IsString({ message: 'nameは文字です' })
@IsNotEmpty({ message: 'nameは必須です' })
name: string;
@ApiProperty()
@IsEmail({}, { message: 'emailはメールアドレスです' })
@IsNotEmpty({ message: 'emailは必須です' })
email: string;
@ApiProperty()
@IsString({ message: 'passwordは文字です' })
@IsNotEmpty({ message: 'passwordは必須です' })
password: string;
}
export class LoginDTO {
@ApiProperty()
@IsEmail({}, { message: 'emailはメールアドレスです' })
@IsNotEmpty({ message: 'emailは必須です' })
email: string;
@ApiProperty()
@IsString({ message: 'passwordは文字です' })
@IsNotEmpty({ message: 'passwordは必須です' })
password: string;
}
3. User 用 dto 作成(レスポンス)
backend/src/user/dto/response.ts に下記のコードをコピーして下さい。
import { ApiProperty } from '@nestjs/swagger';
export class CreateUserResponse {
@ApiProperty({ nullable: true })
id: number | null;
@ApiProperty({ nullable: true })
name: string | null;
}
export class LoginResponse extends CreateUserResponse {}
4. Tweet 用 dto 作成(リクエスト)
backend/src/tweet/dto/request.ts に下記のコードをコピーして下さい。
import { ApiProperty } from '@nestjs/swagger';
import { IsString, IsNotEmpty, Length, IsNumber } from 'class-validator';
export class PostTweetDTO {
@ApiProperty()
@IsNumber({}, { message: 'idは文字です' })
@IsNotEmpty({ message: 'idは必須です' })
id: number;
@ApiProperty()
@IsString({ message: 'contentは文字です' })
@IsNotEmpty({ message: 'contentは必須です' })
@Length(1, 140, { message: 'ツイートは140字以内です' })
content: string;
}
export class SearchTweetDTO {
@ApiProperty()
@IsString({ message: 'textは文字です' })
@IsNotEmpty({ message: 'textは必須です' })
text: string;
}
5. Tweet 用 dto 作成(レスポンス)
backend/src/tweet/dto/response.ts に下記のコードをコピーして下さい。
import { ApiProperty } from '@nestjs/swagger';
class Tweet {
@ApiProperty()
userName: string;
@ApiProperty()
content: string;
@ApiProperty()
createdAt: Date;
}
export class GetTweetResponse {
@ApiProperty({ isArray: true, type: Tweet })
tweetList: Tweet[];
}
export class SearchTweetResponse extends GetTweetResponse {}
export class PostTweetResponse {
@ApiProperty()
message: '成功';
}
6. dto の適用(User コントローラー)
backend/src/user/user.controller.tsに下記の内容を丸ごとコピーしてください。
import { Body, Controller, HttpCode, Post } from '@nestjs/common';
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
import { UserService } from './user.service';
import { CreateUserResponse, LoginResponse } from './dto/response';
import { CreateUserDTO, LoginDTO } from './dto/request';
//@Controller()と@Post()の引数でルーティングを記述
@ApiTags('users')
@Controller('users')
export class UserController {
//UserServiceを使うための記述
constructor(private readonly userService: UserService) {}
@ApiOperation({ summary: '新規登録' })
@ApiResponse({ status: 200, type: CreateUserResponse })
@HttpCode(200)
@Post('create')
async createUser(
@Body() { name, email, password }: CreateUserDTO,
): Promise<CreateUserResponse> {
return;
}
@ApiOperation({ summary: 'ログイン' })
@ApiResponse({ status: 200, type: LoginResponse })
@HttpCode(200)
@Post('login')
async login(
@Body() { email, password }: LoginDTO,
): Promise<LoginResponse> {
return;
}
}
7. dto の適用(Tweet コントローラー)
backend/src/tweet/tweet.controller.tsに下記の内容を丸ごとコピーしてください。
import { Body, Controller, Get, HttpCode, Post } from '@nestjs/common';
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
import { TweetService } from './tweet.service';
import {
GetTweetResponse,
SearchTweetResponse,
PostTweetResponse,
} from './dto/response';
import { PostTweetDTO, SearchTweetDTO } from './dto/request';
//@Controller()と@Post()の引数でルーティングを記述
@ApiTags('tweets')
@Controller('tweets')
export class TweetController {
//TweetServiceを使うための記述
constructor(private readonly tweetService: TweetService) {}
@ApiOperation({ summary: 'ツイート取得' })
@ApiResponse({ status: 200, type: GetTweetResponse })
@HttpCode(200)
@Get()
async getTweet(): Promise<GetTweetResponse> {
return;
}
@ApiOperation({ summary: 'ツイート投稿' })
@ApiResponse({ status: 200, type: PostTweetResponse })
@HttpCode(200)
@Post()
async postTweet(
@Body() { id, content }: PostTweetDTO,
): Promise<PostTweetResponse> {
return;
}
@ApiOperation({ summary: 'ツイート検索' })
@ApiResponse({ status: 200, type: SearchTweetResponse })
@HttpCode(200)
@Post('search')
async searchTweet(
@Body() { text }: SearchTweetDTO,
): Promise<SearchTweetResponse> {
return;
}
}
解説
class-validatorの名前の通り、classを使ってバリデーションと型定義を記述しています。＠Is○○○()でバリデーションを行っていて、例えば＠IsString()ではそのプロパティの値が文字列かどうかを見てくれています。引数で文字列じゃなかったときに表示するメッセージも指定できます。
確認
http://localhost:3002/doc#/ にアクセスして、下記の画面が表示されれば完了です。
その後APIドキュメントを確認してみてください。今まで作成してきた5つのエンドポイントが確認できるはずです。各エンドポイントをクリックすると、APIを試せる画面に切り替わります。「Try it out」を押した後に「Request Body」を編集し、「Execute」を押すとAPIを叩くことができます。今はまだServiceの作成が完了していないので正常に動きませんが、バリデーションは機能しています。試しに「新規登録API」をRequest Bodyをいじらずに叩いてみてください。ステータスコードが400で、返ってきたResponse Bodyのmessageに「"emailはメールアドレスです"」と表示されているはずです。ちゃんとバリデーションができていますね。試しにemailをメールアドレスの形式(例: "string＠gmail.com")等にすると、ステータスコードが200(成功)となります。その他のバリデーションもぜひ試してみてください。ちなみにこの画面はswaggerというツールを使って生成しています。今まで「@nestjs/swagger」からimportされていたデコレータは全てswaggerの為の記述でした。なのでもしもswaggerを使わない場合は、もう少しコードの記述量が減ります。
service の作成
いよいよNestJSにおいて最も重要なServiceの作成をします。Serviceとはロジックの記述を行う場所でした。例えば今回のログイン機能では、入力されたパスワードとメールアドレスの組がデータベース上に存在するかどうか調べるロジックをService上に書いていきます。Service内で以前作成したRepositoryを利用したいので、まずはModuleの修正を行います。
- Module の修正(User)
backend/src/user/user.module.tsに下記のコードを丸ごとコピーしてください。
import { Module } from '@nestjs/common';
import { UserController } from './user.controller';
import { UserService } from './user.service';
import { UserRepository } from '../repository/user.repository';
@Module({
controllers: [UserController],
providers: [UserService, UserRepository], //UserRepositoryをprovidersに追加
})
export class UserModule {}
2. Module の修正(Tweet)
backend/src/tweet/tweet.module.tsに下記のコードを丸ごとコピーしてください。
import { Module } from '@nestjs/common';
import { TweetController } from './tweet.controller';
import { TweetService } from './tweet.service';
import { TweetRepository } from '../repository/tweet.repository';
import { UserRepository } from '../repository/user.repository';
@Module({
controllers: [TweetController],
providers: [TweetService, TweetRepository, UserRepository], //TweetRepository, UserRepositoryをprovidersに記述
})
export class TweetModule {}
3. Service の作成(User)
backend/src/user/user.service.tsに下記のコードを丸ごとコピーしてください。
import { Injectable } from '@nestjs/common';
import { User } from '../entity/user.entity';
import { UserRepository } from '../repository/user.repository';
import * as hasher from 'wordpress-hash-node';
@Injectable()
export class UserService {
constructor(private userRepository: UserRepository) {}
async createUser(
name: string,
email: string,
password: string,
): Promise<{ id: number | null; name: string | null }> {
let newUser: User;
try {
//入力されたメールアドレスを持つユーザーを取得
const existingUser: User | null = await this.userRepository.findOne(
{
where: { email: email },
},
);
//existingUserが存在する=既に登録済みのユーザーが存在する なのでnullにして返す
if (existingUser) {
return { id: null, name: null };
}
//パスワードのハッシユ化
const hashedPassword: string = hasher.HashPassword(password);
//ユーザーを新規作成 + 作成されたユーザーをnewUserに入れる
newUser = await this.userRepository.save(
new User(name, hashedPassword, email, null),
);
} catch (e: any) {
console.log(e);
throw e;
}
return { id: newUser.id, name: newUser.name };
}
async login(
email: string,
password: string,
): Promise<{ id: number; name: string }> {
let result: { id: number; name: string };
try {
//入力されたメールアドレスを持つユーザーを取得
const targetUser: User | null = await this.userRepository.findOne({
where: { email: email },
});
if (!targetUser) {
//targetUserがいない=メールアドレスが異なる なのでnullで返す
return { id: null, name: null };
}
//targetUserのpasswordと入力されたpasswordが一致するか確認(isSamePasswordにはtrueかfalseが入る)
const isSamePassword: boolean = hasher.CheckPassword(
password,
targetUser.password,
);
if (isSamePassword) {
result = { id: targetUser.id, name: targetUser.name };
} else {
return { id: null, name: null };
}
} catch (e: any) {
console.log(e);
throw e;
}
return result;
}
}
4. Service の作成(Tweet)
backend/src/tweet/tweet.service.tsに下記のコードを丸ごとコピーしてください。
import { Injectable } from '@nestjs/common';
import { Tweet } from '../entity/tweet.entity';
import { User } from '../entity/user.entity';
import { TweetRepository } from '../repository/tweet.repository';
import { UserRepository } from '../repository/user.repository';
@Injectable()
export class TweetService {
constructor(
private tweetRepository: TweetRepository,
private userRepository: UserRepository,
) {}
async getTweet(): Promise<{
tweetList: { userName: string; content: string; createdAt: Date }[];
}> {
let tweetList: {
userName: string;
content: string;
createdAt: Date;
}[];
try {
//日付が新しい順に100個取得
const originalTweetList: Tweet[] = await this.tweetRepository.find({
order: { createdAt: 'DESC' },
take: 100,
relations: { user: true },
});
//DTOに適した形に変換(最下部にconvertTweetListの定義あり)
tweetList = this.convertTweetList(originalTweetList);
} catch (e: any) {
console.log(e);
throw e;
}
return { tweetList: tweetList };
}
async postTweet(
userId: number,
content: string,
): Promise<{ message: '成功' }> {
try {
//idからツイートしたuserを取得
const tweetUser: User = await this.userRepository.findOne({
where: { id: userId },
});
//Tweetクラスのインスタンスを生成
const newTweet: Tweet = new Tweet(content, tweetUser);
//上で生成したインスタンスを保存(tweetsテーブルに保存される)
await this.tweetRepository.save(newTweet);
} catch (e: any) {
console.log(e);
throw e;
}
return { message: '成功' };
}
async searchTweet(text: string): Promise<{
tweetList: { userName: string; content: string; createdAt: Date }[];
}> {
let tweetList: {
userName: string;
content: string;
createdAt: Date;
}[];
try {
//TypeORMのQueryBuilderを用いた検索(詳細はtweetRepositoryを参照)
const originalTweetList: Tweet[] =
await this.tweetRepository.searchByQueryBuilder(text);
tweetList = this.convertTweetList(originalTweetList);
} catch (e: any) {
console.log(e);
throw e;
}
return { tweetList: tweetList };
}
//型Tweet[]をDTOに適した形に変換する関数(このサービス内のみで使用)
private convertTweetList(
tweetList: Tweet[],
): { userName: string; content: string; createdAt: Date }[] {
const result = tweetList.map(({ content, createdAt, user }) => {
return {
userName: user.name,
content: content,
createdAt: createdAt,
};
});
return result;
}
}
5. User Repository の修正(SQL の記述を行います)
backend/src/repository/tweet.repository.tsに下記のコードを丸ごとコピーしてください。
import { Injectable } from '@nestjs/common';
import { DataSource, Repository } from 'typeorm';
import { Tweet } from '../entity/tweet.entity';
@Injectable()
export class TweetRepository extends Repository<Tweet> {
constructor(public dataSource: DataSource) {
super(Tweet, dataSource.createEntityManager());
}
//ただSQLを書くのではなく、TypeORMのQueryBuilderを使って書くこともできるよ！という紹介です。理解する必要はありません！
async searchByQueryBuilder(text: string): Promise<Tweet[]> {
let tweetQueryBuilder = this.dataSource
.getRepository(Tweet)
.createQueryBuilder('tweet');
//QueryBuilderでSQLを生成
tweetQueryBuilder = tweetQueryBuilder
.leftJoinAndSelect('tweet.user', 'user') //usersテーブルを結合
.where(`tweet.content like :text`, { text: `%${text}%` }) //SQLのWhere句の生成(LIKE句で部分一致検索)
.orderBy('tweet.createdAt', 'DESC')
.take(100);
//ログに実際に実行されているSQLを表示
console.log(tweetQueryBuilder.getSql(), '-----sqlllllllll-----');
const tweerList: Tweet[] = await tweetQueryBuilder.getMany();
return tweerList;
}
}
6. Controller の修正(User)
backend/src/user/user.controller.tsに下記のコードを丸ごとコピーしてください。
import { Body, Controller, HttpCode, Post } from '@nestjs/common';
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
import { UserService } from './user.service';
import { CreateUserResponse, LoginResponse } from './dto/response';
import { CreateUserDTO, LoginDTO } from './dto/request';
//@Controller()と@Post()の引数でルーティングを記述
@ApiTags('users')
@Controller('users')
export class UserController {
//UserServiceを使うための記述
constructor(private readonly userService: UserService) {}
@ApiOperation({ summary: '新規登録' })
@ApiResponse({ status: 200, type: CreateUserResponse })
@HttpCode(200)
@Post('create')
async createUser(
@Body() { name, email, password }: CreateUserDTO,
): Promise<CreateUserResponse> {
const res = await this.userService.createUser(name, email, password);
return res;
}
@ApiOperation({ summary: 'ログイン' })
@ApiResponse({ status: 200, type: LoginResponse })
@HttpCode(200)
@Post('login')
async login(
@Body() { email, password }: LoginDTO,
): Promise<LoginResponse> {
const res = await this.userService.login(email, password);
return res;
}
}
7. Controller の修正(Tweet)
backend/src/tweet/tweet.controller.tsに下記のコードを丸ごとコピーしてください。
import { Body, Controller, Get, HttpCode, Post } from '@nestjs/common';
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
import { TweetService } from './tweet.service';
import {
GetTweetResponse,
SearchTweetResponse,
PostTweetResponse,
} from './dto/response';
import { PostTweetDTO, SearchTweetDTO } from './dto/request';
//@Controller()と@Post()の引数でルーティングを記述
@ApiTags('tweets')
@Controller('tweets')
export class TweetController {
//TweetServiceを使うための記述
constructor(private readonly tweetService: TweetService) {}
@ApiOperation({ summary: 'ツイート取得' })
@ApiResponse({ status: 200, type: GetTweetResponse })
@HttpCode(200)
@Get()
async getTweet(): Promise<GetTweetResponse> {
const res = await this.tweetService.getTweet();
return res;
}
@ApiOperation({ summary: 'ツイート投稿' })
@ApiResponse({ status: 200, type: PostTweetResponse })
@HttpCode(200)
@Post()
async postTweet(
@Body() { id, content }: PostTweetDTO,
): Promise<PostTweetResponse> {
const res = await this.tweetService.postTweet(id, content);
return res;
}
@ApiOperation({ summary: 'ツイート検索' })
@ApiResponse({ status: 200, type: SearchTweetResponse })
@HttpCode(200)
@Post('search')
async searchTweet(
@Body() { text }: SearchTweetDTO,
): Promise<SearchTweetResponse> {
const res = await this.tweetService.searchTweet(text);
return res;
}
}
詳しい解説
全体の振り返り
1.Moduleの修正(RepositoryをServiceで使えるようにする)
2.Serviceの作成(ロジックの記述)
3.Repositoryの修正(ロジックの記述(SQL)))
4.Controllerの修正(作成したサービスの記述)
を実装しました。
Service内のコードについて解説
Service内では、ユーザー情報等データベース上の情報を取得・新規作成しています。しかし、直接SQLの記述はしていません。代わりに、前パートで作成したrepositoryクラスのメソッド(find, findOne, save等)を使用しています。(正確には各repository作成時に継承していたTypeORMのRepositoryクラスです)このように、ORMを用いればテーブル作成時だけではなく、CRUD処理もSQLを記述することなく行うことができます。
パスワードのハッシュ化について解説
データベースにパスワードを保存する際、ハッシュ化(不規則な文字列への変換)をしてから保存しています。暗号化と何が違うの？と思う方もいるかもしれませんが、1番の違いは不可逆性です。暗号は元に戻せるのに対し、ハッシュ化された文字列を元に戻すことは技術的に困難とされています。なので、仮にデータベースからパスワードが流出しても、悪用される心配が少ないということになります。今回はローカルな環境の開発なのであまりセキュリティに気を配る必要はありませんが、実際に世に出ているサービスはほぼ確実にパスワードのハッシュ化を行っています。(パスワードのハッシュ化については、私も去年やった春休みの課題で学びました)
バックエンドのコードは以上で完成になります！次のパートでは動作確認を行います！
動作確認
データーベースにレコードの挿入ができているか確認
手順1
http://localhost:3002/doc#/ にアクセス
手順2
前回やったように新規登録APIを叩いてみてください。(バリデーションに引っかからないよう、適切な値をRequest bodyに設定が必要)今までの工程が全てうまくいっていれば、データベース上にレコードが挿入されているはずです。
手順3
再度Table Plusを開いて、usersテーブルを確認してみてください。実際に先ほどPOSTした値が挿入されているはずです。同時に、パスワードがハッシュ化されて、読み取れない形になっていることを確認できると思います。
手順4
その他APIに関しても、実際に操作して正常に動作するか確認してみてください
レコード削除・編集に関しては今回APIを用意していないので、必要であればTable Plus上から行ってください。(もちろん自分で新しくAPIを作成してもらっても大丈夫です！ただ、エンドポイントが重複しないよう気をつけてください)
cors の設定
フロントエンド側からAPIを叩くにはCORSの設定をしておく必要があります。ここでは説明しないので、気になる方は調べてみてください！
1. main.ts の修正
backend/src/main.tsに下記のコードを丸ごとコピー
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { ValidationPipe } from '@nestjs/common';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
// 追加
app.enableCors({
origin: '*',
allowedHeaders: 'Origin, X-Requested-With, Content-Type, Accept',
});
// ここまで
const config = new DocumentBuilder().build();
const document = SwaggerModule.createDocument(app, config);
app.useGlobalPipes(new ValidationPipe());
SwaggerModule.setup('doc', app, document);
await app.listen(3002);
}
bootstrap();
最後に
バックエンド編お疲れ様でした！
正直全然わかんなかった！という人が大半だと思います。でも大丈夫です。最初にも伝えた通り、今回はコードの理解ではなく、WEBアプリケーション作成に慣れてもらうことを目的としています。とりあえず動くものをプログラミングで作ることができた！という実感が得られれば十分だと思います！今後のゼミの活動で否が応でも何かしら作ることになるので、1年後には余裕で理解できるようになっていると思います！
次は、フロントエンド編です。頑張ってください！！