[update] 1.0.0 - MVC

.gitignore

@@ -0,0 +1,2 @@
+/app/.env
+launch.json

README.md

@@ -1,2 +1,18 @@
-# go-crud-boilerplate
-This is a boilerplate for creating CRUD application working with go.
+# go-api-boilerplate
+This is an api boilerplate built with golang.
+
+- golang
+- mysql
+- docker
+
+# Get Started
+`cp app/.env_example app/.env`
+`docker-compose build`
+`docker-compose up`
+
+After running docker, you need to execute sql files in `app/database/sql`.
+
+# References
+I refered to this repository.
+
+- [github - rymccue/golang-standard-lib-rest-api](https://github.com/rymccue/golang-standard-lib-rest-api)

app/.env_example

@@ -0,0 +1,7 @@
+SERVER_PORT=8080
+DB_DRIVER=mysql
+DB_USER=root
+DB_PASSWORD=password
+DB_HOST=mysql
+DB_PORT=3306
+DB_DATABASE=go_api_boilerplate

app/.realize.yaml

@@ -0,0 +1,19 @@
+settings:
+  legacy:
+    force: false
+    interval: 0s
+schema:
+- name: go-api-boilerplate
+  path: .
+  commands:
+    run:
+      status: true
+  watcher:
+    extensions:
+    - go
+    paths:
+    - /
+    ignored_paths:
+    - .git
+    - .realize
+    - vendor

app/config/env.go

@@ -0,0 +1,32 @@
+package config
+
+import (
+	"bufio"
+	"fmt"
+	"os"
+	"strings"
+)
+
+func LoadEnv() {
+	filePath := ".env"
+	f, err := os.Open(filePath)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "File %s could not read: %v\n", filePath, err)
+		os.Exit(1)
+	}
+	defer f.Close()
+
+	lines := make([]string, 0, 100)
+	scanner := bufio.NewScanner(f)
+	for scanner.Scan() {
+		lines = append(lines, scanner.Text())
+	}
+	if err := scanner.Err(); err != nil {
+		fmt.Fprintf(os.Stderr, "File %s scan error: %v\n", filePath, err)
+	}
+
+	for _, e := range lines {
+		pair := strings.Split(e, "=")
+		os.Setenv(pair[0], pair[1])
+	}
+}

app/database/database.go

@@ -0,0 +1,23 @@
+package database
+
+import (
+	"database/sql"
+	"fmt"
+	"log"
+	"os"
+)
+
+func Connect() (db *sql.DB) {
+	dataSourceName := fmt.Sprintf("%s:%s@tcp(%s:%s)/%s", os.Getenv("DB_USER"), os.Getenv("DB_PASSWORD"), os.Getenv("DB_HOST"), os.Getenv("DB_PORT"), os.Getenv("DB_DATABASE"))
+	db, err := sql.Open(os.Getenv("DB_DRIVER"), dataSourceName)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	err = db.Ping()
+	if err != nil {
+		fmt.Println("Failed to connected DB:", err)
+	}
+
+	return db
+}

app/database/sql/faker.sql

@@ -0,0 +1,5 @@
+INSERT INTO users(name) VALUES('foo');
+INSERT INTO users(name) VALUES('bar');
+
+INSERT INTO posts(user_id, body) VALUES(1, 'Hello World');
+INSERT INTO posts(user_id, body) VALUES(2, 'Hi');

app/database/sql/schema.sql

@@ -0,0 +1,10 @@
+CREATE TABLE IF NOT EXISTS `users` (
+  `id` INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+  `name` VARCHAR(255)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+CREATE TABLE IF NOT EXISTS `posts` (
+  `id` INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+  `user_id` INT UNSIGNED NOT NULL,
+  `body` TEXT
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;

app/handler/user_handler.go

@@ -0,0 +1,54 @@
+package handler
+
+import (
+	"database/sql"
+	"encoding/json"
+	"log"
+	"net/http"
+
+	"../repository"
+)
+
+type UserHandler struct {
+	DB *sql.DB
+}
+
+func NewUserHandler(db *sql.DB) *UserHandler {
+	return &UserHandler{
+		DB: db,
+	}
+}
+
+func (uh *UserHandler) Index(w http.ResponseWriter, r *http.Request) {
+	// TODO: 以下のメソッド方針で実装
+	// list	一覧を取得する
+	// get	IDを指定して、一件取得する
+	// insert	新規作成する
+	// update	上書きする
+	// patch	部分的に上書きする
+	// delete	指定したIDに対応するものを削除する
+
+	// TODO: method 振り分け
+	// switch r.Method {
+	// 	case http.MethodPost:
+	//     	Register(w, r)
+	// 	case http.MethodGet:
+	//     	Reader(w, r)
+	// 	case http.MethodPut:
+	//     	Updater(w, r)
+	// 	case http.MethodDelete:
+	//     	Deleter(w, r)
+	// 	default:
+	//     	NotFoundResources(w, r)
+
+	// TODO: ルーティング処理は切り出したい controllerとhandlerは別・・？ handlerにできるならhandlerにリネームした
+	// TODO: ここが処理のメイン userrepositoryはどっかの引数に取るとかしても良いのでは
+	users, err := repository.UserRepositoryIndex(uh.DB)
+	if err != nil {
+		log.Fatalf("show users list error: %s", err)
+		http.Error(w, "", http.StatusInternalServerError)
+		return
+	}
+	w.Header().Set("Content-Type", "application/json")
+	json.NewEncoder(w).Encode(users)
+}

app/main.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"log"
+	"net/http"
+	"os"
+
+	"./config"
+	"./database"
+	"./route"
+	_ "github.com/go-sql-driver/mysql"
+)
+
+func main() {
+	config.LoadEnv()
+	db := database.Connect()
+
+	mux := http.NewServeMux()
+	route.Dispatch(mux, db)
+
+	if err := http.ListenAndServe(":"+os.Getenv("SERVER_PORT"), mux); err != nil {
+		log.Fatal(err)
+	}
+}

app/model/user_model.go

@@ -0,0 +1,6 @@
+package model
+
+type UserModel struct {
+	ID   int    `json:"id"`
+	Name string `json:"name"`
+}

app/repository/user_repository.go

@@ -0,0 +1,20 @@
+package repository
+
+import (
+	"database/sql"
+
+	"../model"
+)
+
+func UserRepositoryIndex(db *sql.DB) (*model.UserModel, error) {
+	const query = `
+		select 
+			id,
+			name
+		from
+			users
+	`
+	var user model.UserModel
+	err := db.QueryRow(query).Scan(&user.ID, &user.Name)
+	return &user, err
+}

app/route/routes.go

@@ -0,0 +1,14 @@
+package route
+
+import (
+	"database/sql"
+	"net/http"
+
+	"../handler"
+)
+
+func Dispatch(mux *http.ServeMux, db *sql.DB) {
+	userHandler := handler.NewUserHandler(db)
+
+	mux.HandleFunc("/users", userHandler.Index)
+}

docker-compose.yml

@@ -0,0 +1,24 @@
+version: "3"
+services:
+  golang:
+    container_name: "golang"
+    build: ./docker/go
+    volumes:
+      - ./app:/usr/local/project:delegated
+    ports:
+      - "8080:8080"
+    depends_on:
+      - mysql
+  mysql:
+    container_name: "mysql"
+    build: ./docker/mysql
+    ports:
+      - "3306:3306"
+    volumes:
+      - mysql_db:/var/lib/mysql:delegated
+    environment:
+      - MYSQL_DATABASE=go_api_boilerplate
+      - MYSQL_ROOT_PASSWORD=password
+volumes:
+  mysql_db:
+    driver: local

docker/go/Dockerfile

@@ -0,0 +1,9 @@
+FROM golang:1.10.7-alpine3.8
+
+WORKDIR /usr/local/project
+
+RUN apk add --no-cache git
+RUN go get github.com/go-sql-driver/mysql
+RUN go get github.com/oxequa/realize
+
+CMD realize start

docker/mysql/Dockerfile

@@ -0,0 +1,5 @@
+FROM mysql:5.7
+
+ADD ./my.cnf /etc/mysql/conf.d/my.cnf
+
+CMD ["mysqld"]

docker/mysql/my.cnf

@@ -0,0 +1,8 @@
+[mysqld]
+character-set-server=utf8
+
+[mysql]
+default-character-set=utf8
+
+[client]
+default-character-set=utf8