当前位置：网站首页>Take you ten days to easily complete the go micro service series (I)

Take you ten days to easily complete the go micro service series (I)

2022-07-02 16:32:00 【Wan Junfeng, Kevin】

This article begins , We will publish a series of articles to show you one in detail go-zero Microservice example , The whole series is divided into ten articles , The directory structure is as follows ：

Environment building （ this paper ）
Service split
Customer service
Product service
Order service
Payment services
RPC service Auth verification
Service monitoring
Link tracking
Distributed transactions

I hope this series will take you to use it locally Docker Environmental utilization go-zero Quickly develop a mall system , Let you get started with micro services quickly .

Complete sample code ： https://github.com/nivin-studio/go-zero-mall

1 Environmental requirements

Golang 1.15+
Etcd
Redis
Mysql
Prometheus
Grafana
Jaeger
DTM

2 `Docker` Local development environment construction

For the convenience of development and debugging , We use Docker Building a local development environment .Windows and macOS The system can be downloaded Docker Desktop Install and use , For specific download and installation methods, you can search relevant tutorials by yourself .

Here we use Docker Compose To orchestrate and manage our containers , Create the following directory ：

gonivinck
├── dtm                   # DTM  Distributed transaction manager 
│   ├── config.yml        # DTM  The configuration file 
│   └── Dockerfile
├── etcd                  # Etcd  Service registration found 
│   └── Dockerfile
├── golang                # Golang  Running environment 
│   └── Dockerfile
├── grafana               # Grafana  Visual data monitoring 
│   └── Dockerfile
├── jaeger                # Jaeger  Link tracking 
│   └── Dockerfile
├── mysql                 # Mysql  service 
│   └── Dockerfile
├── mysql-manage          # Mysql  Visual management 
│   └── Dockerfile
├── prometheus            # Prometheus  Service monitoring 
│   ├── Dockerfile
│   └── prometheus.yml    # Prometheus  The configuration file 
├── redis                 # Redis  service 
│   └── Dockerfile
├── redis-manage          # Redis  Visual management 
│   └── Dockerfile
├── .env                  # env  To configure 
└── docker-compose.yml

     
      1.
      2.
      3.
      4.
      5.
      6.
      7.
      8.
      9.
      10.
      11.
      12.
      13.
      14.
      15.
      16.
      17.
      18.
      19.
      20.
      21.
      22.
      23.
      24.
      25.

2.1 To write `Dockerfile`

stay go-zero In the microservices of grpc Communication between services , and grpc You need to use protoc And translate into go Language rpc stub Code plug-ins protoc-gen-go.

To improve development efficiency , Reduce the error rate of code , Reduce the workload of business development ,go-zero It also provides goctl Code generation tool .

therefore , We need to protoc, protoc-gen-go, goctl, Install in advance to golang In the container , For later use .

therefore golang Container of Dockerfile The code is as follows ：

FROM golang:1.17

LABEL maintainer="Ving <[email protected]>"

ENV GOPROXY https://goproxy.cn,direct

#  Install the necessary software packages and dependent packages 
USER root
RUN sed -i 's/deb.debian.org/mirrors.tuna.tsinghua.edu.cn/' /etc/apt/sources.list && \
    sed -i 's/security.debian.org/mirrors.tuna.tsinghua.edu.cn/' /etc/apt/sources.list && \
    sed -i 's/security-cdn.debian.org/mirrors.tuna.tsinghua.edu.cn/' /etc/apt/sources.list && \
    apt-get update && \
    apt-get upgrade -y && \
    apt-get install -y --no-install-recommends \
    curl \
    zip \
    unzip \
    git \
    vim 

#  install  goctl
USER root
RUN GOPROXY=https://goproxy.cn/,direct go install github.com/tal-tech/go-zero/tools/[email protected]

#  install  protoc
USER root
RUN curl -L -o /tmp/protoc.zip https://github.com/protocolbuffers/protobuf/releases/download/v3.19.1/protoc-3.19.1-linux-x86_64.zip && \
    unzip -d /tmp/protoc /tmp/protoc.zip && \
    mv /tmp/protoc/bin/protoc $GOPATH/bin

#  install  protoc-gen-go
USER root
RUN go get -u github.com/golang/protobuf/[email protected]

# $GOPATH/bin Add to environment variable 
ENV PATH $GOPATH/bin:$PATH

#  Clean up the rubbish 
USER root
RUN apt-get clean && \
    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* && \
    rm /var/log/lastlog /var/log/faillog

#  Set up the working directory 
WORKDIR /usr/src/code

EXPOSE 8000
EXPOSE 8001
EXPOSE 8002
EXPOSE 8003
EXPOSE 9000
EXPOSE 9001
EXPOSE 9002
EXPOSE 9003

     
      1.
      2.
      3.
      4.
      5.
      6.
      7.
      8.
      9.
      10.
      11.
      12.
      13.
      14.
      15.
      16.
      17.
      18.
      19.
      20.
      21.
      22.
      23.
      24.
      25.
      26.
      27.
      28.
      29.
      30.
      31.
      32.
      33.
      34.
      35.
      36.
      37.
      38.
      39.
      40.
      41.
      42.
      43.
      44.
      45.
      46.
      47.
      48.
      49.
      50.
      51.
      52.
      53.
      54.

Other service containers Dockerfile No special treatment required , Just based on the existing image .

service	Based on the image
DTM	yedf/dtm
Etcd	bitnami/etcd
Mysql	mysql:5.7
Redis	redis:5.0
Mysql Manage	phpmyadmin/phpmyadmin
Redis Manage	erikdubbelboer/phpredisadmin
Prometheus	bitnami/prometheus
Grafana	grafana/grafana
Jaeger	jaegertracing/all-in-one:1.28

2.2 To write `.env` The configuration file

#  Set time zone 
TZ=Asia/Shanghai
#  Set network mode 
NETWORKS_DRIVER=bridge


# PATHS ##########################################
#  The directory path where the code is stored on the host 
CODE_PATH_HOST=./code
#  The host machine Mysql Reids Directory path of data storage 
DATA_PATH_HOST=./data


# MYSQL ##########################################
# Mysql  Service mapping host port number , It can be on the host 127.0.0.1:3306 visit 
MYSQL_PORT=3306
MYSQL_USERNAME=admin
MYSQL_PASSWORD=123456
MYSQL_ROOT_PASSWORD=123456

# Mysql  Visual management user name , Same as  MYSQL_USERNAME
MYSQL_MANAGE_USERNAME=admin
# Mysql  Visually manage user passwords , Same as  MYSQL_PASSWORD
MYSQL_MANAGE_PASSWORD=123456
# Mysql  Visual management ROOT User password , Same as  MYSQL_ROOT_PASSWORD
MYSQL_MANAGE_ROOT_PASSWORD=123456
# Mysql  Service address 
MYSQL_MANAGE_CONNECT_HOST=mysql
# Mysql  Service port number 
MYSQL_MANAGE_CONNECT_PORT=3306
# Mysql  Visual management mapping host port number , It can be on the host 127.0.0.1:1000 visit 
MYSQL_MANAGE_PORT=1000


# REDIS ##########################################
# Redis  Service mapping host port number , It can be on the host 127.0.0.1:6379 visit 
REDIS_PORT=6379

# Redis  Visual management user name 
REDIS_MANAGE_USERNAME=admin
# Redis  Visually manage user passwords 
REDIS_MANAGE_PASSWORD=123456
# Redis  Service address 
REDIS_MANAGE_CONNECT_HOST=redis
# Redis  Service port number 
REDIS_MANAGE_CONNECT_PORT=6379
# Redis  Visual management mapping host port number , It can be on the host 127.0.0.1:2000 visit 
REDIS_MANAGE_PORT=2000


# ETCD ###########################################
# Etcd  Service mapping host port number , It can be on the host 127.0.0.1:2379 visit 
ETCD_PORT=2379


# PROMETHEUS #####################################
# Prometheus  Service mapping host port number , It can be on the host 127.0.0.1:3000 visit 
PROMETHEUS_PORT=3000


# GRAFANA ########################################
# Grafana  Service mapping host port number , It can be on the host 127.0.0.1:4000 visit 
GRAFANA_PORT=4000


# JAEGER #########################################
# Jaeger  Service mapping host port number , It can be on the host 127.0.0.1:5000 visit 
JAEGER_PORT=5000


# DTM #########################################
# DTM HTTP  Protocol port number 
DTM_HTTP_PORT=36789
# DTM gRPC  Protocol port number 
DTM_GRPC_PORT=36790

     
      1.
      2.
      3.
      4.
      5.
      6.
      7.
      8.
      9.
      10.
      11.
      12.
      13.
      14.
      15.
      16.
      17.
      18.
      19.
      20.
      21.
      22.
      23.
      24.
      25.
      26.
      27.
      28.
      29.
      30.
      31.
      32.
      33.
      34.
      35.
      36.
      37.
      38.
      39.
      40.
      41.
      42.
      43.
      44.
      45.
      46.
      47.
      48.
      49.
      50.
      51.
      52.
      53.
      54.
      55.
      56.
      57.
      58.
      59.
      60.
      61.
      62.
      63.
      64.
      65.
      66.
      67.
      68.
      69.
      70.
      71.
      72.
      73.
      74.
      75.

2.3 To write `docker-compose.yml` The configuration file

version: '3.5'
#  The network configuration 
networks:
  backend:
    driver: ${NETWORKS_DRIVER}

#  Service container configuration 
services:
  golang:                                #  Custom container name 
    build:
      context: ./golang                  #  Specify the  Dockerfile  file 
    environment:                         #  Set the environment variable 
      - TZ=${TZ}
    volumes:                             #  Set the mount Directory 
      - ${CODE_PATH_HOST}:/usr/src/code  #  quote  .env  Configuration in progress  CODE_PATH_HOST  Variable , Mount the directory where the code is stored on the host to the container  /usr/src/code  Catalog 
    ports:                               #  Set port mapping 
      - "8000:8000"
      - "8001:8001"
      - "8002:8002"
      - "8003:8003"
      - "9000:9000"
      - "9001:9001"
      - "9002:9002"
      - "9003:9003"
    stdin_open: true                     #  Open standard input , Can accept external input 
    tty: true
    networks:
      - backend
    restart: always                      #  Specifies that the restart policy after the container exits is always restart 

  etcd:                                  #  Custom container name 
    build:
      context: ./etcd                    #  Specify the  Dockerfile  file 
    environment:
      - TZ=${TZ}
      - ALLOW_NONE_AUTHENTICATION=yes
      - ETCD_ADVERTISE_CLIENT_URLS=http://etcd:2379
    ports:                               #  Set port mapping 
      - "${ETCD_PORT}:2379"
    networks:
      - backend
    restart: always

  mysql:
    build:
      context: ./mysql
    environment:
      - TZ=${TZ}
      - MYSQL_USER=${MYSQL_USERNAME}                  #  Set up  Mysql  User name 
      - MYSQL_PASSWORD=${MYSQL_PASSWORD}              #  Set up  Mysql  User password 
      - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}    #  Set up  Mysql root  User password 
    volumes:
      - ${DATA_PATH_HOST}/mysql:/var/lib/mysql        #  quote  .env  Configuration in progress  DATA_PATH_HOST  Variable , Store on the host  Mysql  The directory of data is mounted in the container  /var/lib/mysql  Catalog 
    ports:
      - "${MYSQL_PORT}:3306"                          #  Set up containers 3306 The port mapping specifies the host port 
    networks:
      - backend
    restart: always

  redis:
    build:
      context: ./redis
    environment:
      - TZ=${TZ}
    volumes:
      - ${DATA_PATH_HOST}/redis:/data                 #  quote  .env  Configuration in progress  DATA_PATH_HOST  Variable , Store on the host  Redis  The directory of data is mounted in the container  /data  Catalog 
    ports:
      - "${REDIS_PORT}:6379"                          #  Set up containers 6379 The port mapping specifies the host port 
    networks:
      - backend
    restart: always

  mysql-manage:
    build:
      context: ./mysql-manage
    environment:
      - TZ=${TZ}
      - PMA_ARBITRARY=1
      - MYSQL_USER=${MYSQL_MANAGE_USERNAME}               #  Set up the connected  Mysql  Service user name 
      - MYSQL_PASSWORD=${MYSQL_MANAGE_PASSWORD}           #  Set up the connected  Mysql  Service user password 
      - MYSQL_ROOT_PASSWORD=${MYSQL_MANAGE_ROOT_PASSWORD} #  Set up the connected  Mysql  service  root  User password 
      - PMA_HOST=${MYSQL_MANAGE_CONNECT_HOST}             #  Set up the connected  Mysql  service  host, It can be  Mysql  Name of the service container , It can also be  Mysql  Of the service container  ip  Address 
      - PMA_PORT=${MYSQL_MANAGE_CONNECT_PORT}             #  Set up the connected  Mysql  Service port number 
    ports:
      - "${MYSQL_MANAGE_PORT}:80"                         #  Set up containers 80 The port mapping specifies the host port , For host access visualization web
    depends_on:                                           #  Rely on the container 
      - mysql                                             #  stay  Mysql  Start after the service container starts 
    networks:
      - backend
    restart: always

  redis-manage:
    build:
      context: ./redis-manage
    environment:
      - TZ=${TZ}
      - ADMIN_USER=${REDIS_MANAGE_USERNAME}           #  Set up  Redis  User name of visual management 
      - ADMIN_PASS=${REDIS_MANAGE_PASSWORD}           #  Set up  Redis  User password for visual management 
      - REDIS_1_HOST=${REDIS_MANAGE_CONNECT_HOST}     #  Set up the connected  Redis  service  host, It can be  Redis  Name of the service container , It can also be  Redis  Of the service container  ip  Address 
      - REDIS_1_PORT=${REDIS_MANAGE_CONNECT_PORT}     #  Set up the connected  Redis  Service port number 
    ports:
      - "${REDIS_MANAGE_PORT}:80"                     #  Set up containers 80 The port mapping specifies the host port , For host access visualization web
    depends_on:                                       #  Rely on the container 
      - redis                                         #  stay  Redis  Start after the service container starts 
    networks:
      - backend
    restart: always

  prometheus:
    build:
      context: ./prometheus
    environment:
      - TZ=${TZ}
    volumes:
      - ./prometheus/prometheus.yml:/opt/bitnami/prometheus/conf/prometheus.yml  #  take  prometheus  Mount the configuration file into the container 
    ports:
      - "${PROMETHEUS_PORT}:9090"                     #  Set up containers 9090 The port mapping specifies the host port , For host access visualization web
    networks:
      - backend
    restart: always

  grafana:
    build:
      context: ./grafana
    environment:
      - TZ=${TZ}
    ports:
      - "${GRAFANA_PORT}:3000"                        #  Set up containers 3000 The port mapping specifies the host port , For host access visualization web
    networks:
      - backend
    restart: always

  jaeger:
    build:
      context: ./jaeger
    environment:
      - TZ=${TZ}
    ports:
      - "${JAEGER_PORT}:16686"                        #  Set up containers 16686 The port mapping specifies the host port , For host access visualization web
    networks:
      - backend
    restart: always

  dtm:
    build:
      context: ./dtm
    environment:
      - TZ=${TZ}
    entrypoint:
      - "/app/dtm/dtm"
      - "-c=/app/dtm/configs/config.yaml"
    volumes:
      - ./dtm/config.yml:/app/dtm/configs/config.yaml #  take  dtm  Mount the configuration file into the container 
    ports:
      - "${DTM_HTTP_PORT}:36789"
      - "${DTM_GRPC_PORT}:36790"
    networks:
      - backend
    restart: always

     
      1.
      2.
      3.
      4.
      5.
      6.
      7.
      8.
      9.
      10.
      11.
      12.
      13.
      14.
      15.
      16.
      17.
      18.
      19.
      20.
      21.
      22.
      23.
      24.
      25.
      26.
      27.
      28.
      29.
      30.
      31.
      32.
      33.
      34.
      35.
      36.
      37.
      38.
      39.
      40.
      41.
      42.
      43.
      44.
      45.
      46.
      47.
      48.
      49.
      50.
      51.
      52.
      53.
      54.
      55.
      56.
      57.
      58.
      59.
      60.
      61.
      62.
      63.
      64.
      65.
      66.
      67.
      68.
      69.
      70.
      71.
      72.
      73.
      74.
      75.
      76.
      77.
      78.
      79.
      80.
      81.
      82.
      83.
      84.
      85.
      86.
      87.
      88.
      89.
      90.
      91.
      92.
      93.
      94.
      95.
      96.
      97.
      98.
      99.
      100.
      101.
      102.
      103.
      104.
      105.
      106.
      107.
      108.
      109.
      110.
      111.
      112.
      113.
      114.
      115.
      116.
      117.
      118.
      119.
      120.
      121.
      122.
      123.
      124.
      125.
      126.
      127.
      128.
      129.
      130.
      131.
      132.
      133.
      134.
      135.
      136.
      137.
      138.
      139.
      140.
      141.
      142.
      143.
      144.
      145.
      146.
      147.
      148.
      149.
      150.
      151.
      152.
      153.
      154.
      155.
      156.
      157.
      158.
      159.

2.4 Build and run

Use docker-compose Command to build and start our service container , Execute the following command in the root directory ：

Container building
stay Windows The system container construction appears as shown in the following figure , Please select Share it This will allow Windows Mount the file directory of to the container directory .
The container has started running

2.5 Container description

Container name	Exposed port	host Address	explain
golang	8000:8000<br>8001:8001<br>8002:8002<br>8003:8003<br>9000:9000<br>9001:9001<br>9002:9002<br>9003:9003	golang	In the production environment, microservices are generally deployed in clusters , Maybe one microservice and one server , It may also be a microservice and a container . For the convenience of development and debugging , We will be in `golang` Start all microservices in the container , And assign them different port numbers for listening to distinguish .<br>80： The port number at the beginning will be used for `api` service <br>90： The port number at the beginning will be used for `rpc` service
dtm	36789:36789<br>36790:36790	dtm	`dtm` Of `http` The protocol and `grpc` Protocol service port number , For client interaction .<br> In this project, we only `Docker` Access between internal containers , Therefore, the port number can not be exposed to the host
etcd	2379:2379	etcd	`Etcdhttp api` Service port number , For client interaction .<br> In this project, we only `Docker` Access between internal containers , Therefore, the port number can not be exposed to the host
mysql	3306:3306	mysql	`Mysql` Service default port number , The host computer can pass through `127.0.0.1:3306` Connect to the database
redis	6379:6379	redis	`Redis` Service default port number , The host computer can pass through `127.0.0.1:6379` Connect to the database
mysql-manage	1000:80	mysql-manage	`phpMyAdminweb` Service port number , It can be on the host `127.0.0.1:1000` visit
redis-manage	2000:80	redis-manage	`phpRedisAdminweb` Service port number , It can be on the host `127.0.0.1:2000` visit
prometheus	3000:9090	prometheus	`Prometheusweb` Service port number , It can be on the host `127.0.0.1:3000` visit
grafana	4000:3000	grafana	`Grafanaweb` Service port number , It can be on the host `127.0.0.1:4000` visit
jaeger	5000:16686	jaeger	`Jaegerweb` Service port number , It can be on the host `127.0.0.1:5000` visit