SpringBootでWebAPI開発

はじめに

妻がSpringBootを触ってみたいとのことなので、
環境構築からやること・必要なことなどをまとめておく。

前提

キーワード	中身
PC	Mac book pro(Intel 2016)
OS	macOS Monterey 12.4
IDE	IntelliJ IDEA Community Edition , VS Code
JDK	temurin-17.0.3
Build Tool	Gradle
Docker	Docker Desktop for Mac
version管理	Github & Sourcetree
API Client	Postman

学ぶこと

キーワード	中身
Spring Initializr	Springのライブラリの選択について
Java	Java17までに追加された構文
Gradle	ビルドツール
Docker	起動方法とか

環境構築 - Install -

1. OSを最新化する
2. JetBrains より IntelliJ IDEA Community Edition をインストール
3. VS Code をインストール
4. Postman をインストール
5. Docker Desktop for Mac をインストール
6. Docker Hubでアカウントを作成する
7. Githubでアカウントを作成する
8. Sourcetree をインストール
9. Sourcetree でGithubのアカウントと連携する

環境構築 - Create Project -

Create Github Repository

1. Githubでリポジトリを作成する
2. 作成したリポジトリのデフォルトブランチを切り替え & 保護
   Settings -> Braches -> Default branch -> developへ
3. 作成したリポジトリを Sourcetree を使ってローカルに clone
   $ git clone https://github.com/{user_id}/{repository_name}.git
4. Githubで issue を起票
5. 起票した issue から create branch
6. Sourcetree で作成した branch に切り替える
   $ git checkout {branch_name}

Create Java Project

1. IntelliJ IDEA でローカルのリポジトリを取り込む
2. Spring Initializr より、Javaプロジェクトを作成し、zipファイルをダウンロード
   dependency に、以下を指定
   ・Lombok
   ・Spring Web
   ・SpringData JPA
   ・MySQL Driver
   ・Spring Boot Actuator
3. ダウンロードしたzipファイルを解凍する
4. IntelliJ IDEA で解凍したファイルを取り込む
5. IntelliJ IDEA でSDKの設定で Eclipse Temurin をダウンロードし、 temurin-17.0.3 という名前でインストールする
6. 一度 Gradleのメニューより BootRun(Tasks->application->bootRun) し、起動を確認する

Merge

1. Sourcetree でファイルを commit & push する
2. Githubで Pull Request を作成する
3. 作成した Pull Request から develop に merge する
   作成した branch を delete する

環境構築 - Docker -

1. Githubで issue を起票
2. 起票した issue から create branch
3. Sourcetree で作成した branch に切り替える
4. docker-compose.yml を作成する
   $ mkdir docker
$ vi ./docker/docker-compose.yml
5. docker-compose.yml に mysql , phpmyadmin のイメージを指定する
6. 起動確認
   $ docker-compose -f ./docker/docker-compose.yml up --build --remove-orphans で起動する
7. 起動確認後、コマンドを README.md か issue に記載する
8. Sourcetree でファイルを commit & push する
9. Githubで Pull Request を作成する
10. 作成した Pull Request から develop に merge する
    作成した branch を delete する

製造

1. phpmyadmin より create database
   例) $ create database sample;
2. application.yml に mysql の設定を追記する
   例) spring.datasource.url=jdbc:mysql://localhost:3306/sample
3. phpmyadmin より create table
   例) $ create table sample.hoge;
4. 作ったテーブルに対応する @Entity がついた class を作成する
5. Entity を操作する Repository を extends した interface を作成する
6. Controller から上記 Repository を操作し、jsonを返却してみる
7. Postman で動作確認を行う

ふりかえり

WIP