DEV Community: JU DaDao

How to use Golang local module

JU DaDao — Thu, 18 Apr 2024 05:20:01 +0000

Go module使用邏輯

在project當中依專案大小的不同可能需要將工作分成多個module。跟C以及C++不同，你無法使用相對路徑去做import，你必須import的是package，而package 的dir由go.mod決定。

流程大綱

假設我現在有一個專案叫做goMd，創建goMd資料夾之後cd進去
在goMod資料夾下創建main.go
在專案底下輸入以下指令，進行init後創建go.mod
假設有兩個module 叫做hello以及note，且分別為不同的package hello以及note
在main中import，以目前的路徑(goMd) import裡面的package
執行 main.go

細部講解

最終的結構會如下

創建專案資料夾goMd
創建main.go
終端機進入goMd資料夾並且在輸入init 指令。將之後import位置調整至goMd

go init指令

  go mod init goMod

go.Mod內容

  module goMod

  go 1.22.1

4.
創建你想要import的module。並且設定pakage name用於之後import。這邊創建兩個pakage分別是hello跟note。

先分別創建hello跟note 資料夾在goMd之下

並且在hello 資料夾下創建hello.go，並且這邊先示範加入SayHello() function。package hello。(記住func name開頭必須要大寫才會是全域，之後在main.go 才能夠使用)

  //hello.go
  package hello

  import "fmt"

  func SayHello() {
      fmt.Println("Hello, world!")
  }

note 資料夾下創建note.go，並且這邊先示範加入Sayhello2() function。package note。(記住func name開頭必須要大寫才會是全域，之後在main.go 才能夠使用)

  //note.go
  package note

  import "fmt"

  func Sayhello2() {
    fmt.Println("hello test")
  }

創建完之後的結構如下

5.
在main中import，記住import根目錄位置會跟go.mod內的位置相同，且import為import pakge的名字。import後直接指定pakage呼叫他裡面的function後可以直接使用

  //main.go
  package main

  import (
    "fmt"
    "goMod/hello"
    "goMod/note"
  )

  func main() {
    hello.SayHello()
    note.Sayhello2()

    fmt.Println("Main print")
  }

6.
run main.go

Go的基本操作(一)

JU DaDao — Thu, 22 Feb 2024 09:12:45 +0000

基本儲存型態、變數以及迴圈用法

數值計算

各型態
- string, integer, floats, booleans, booleans operaters

package main

      import "fmt"

      func main() {

          fmt.Println("go" + "lang")

          fmt.Println("1+1 =", 1+1)
          fmt.Println("7.0/3.0 =", 7.0/3.0)

          fmt.Println(true && false)
          fmt.Println(true || false)
          fmt.Println(!true)
      }

- string可以直接做相加合併，其他如同C/C++規則

變數宣告使用


    package main

    import "fmt"

    func main() {

        var a = "initial"
        fmt.Println(a)

        var b, c int = 1, 2
        fmt.Println(b, c)

        var d = true
        fmt.Println(d)

        var e int
        fmt.Println(e)

        f := "apple"
        fmt.Println(f)
    }

可以一次宣告多個變數。且比較特殊的是最後的:=。他是一個簡化的宣告，可以依據後方的內容去決定var的型態。
- const用法


    package main

    import (
        "fmt"
        "math"
    )

    const s string = "constant"

    func main() {
        fmt.Println(s)

        const n = 500000000

        const d = 3e20 / n
        fmt.Println(d)

        fmt.Println(int64(d))

        fmt.Println(math.Sin(n))
    }

可以宣告在各 var的位置前。但是在指定變數型態之前都是不確定型態的，如最後的d


    fmt.Println(d)
    //6e+11
    fmt.Println(int64(d))
    //600000000000

For迴圈

    package main

    import "fmt"

    func main() {

        i := 1
        for i <= 3 {
            fmt.Println(i)
            i = i + 1
        }

        for j := 0; j < 3; j++ {
            fmt.Println(j)
        }

        for i := range 3 {
            fmt.Println("range", i)
        }

        for {
            fmt.Println("loop")
            break
        }

        for n := range 6 {
            if n%2 == 0 {
                continue
            }
            fmt.Println(n)
        }
    }

這邊介紹了幾種for迴圈的方式，與C/c++不同不需要"()"，且也支援range。還有一個用法是倒數遞二種，for 然後沒有接任何condition的用法。他會執行到讀取到break為止。在示範中print一次"loop"字串就結束了。
- IF/else 用法跟 c 一樣

    package main

    import "fmt"

    func main() {

        if 7%2 == 0 {
            fmt.Println("7 is even")
        } else {
            fmt.Println("7 is odd")
        }

        if 8%4 == 0 {
            fmt.Println("8 is divisible by 4")
        }

        if 8%2 == 0 || 7%2 == 0 {
            fmt.Println("either 8 or 7 are even")
        }

        if num := 9; num < 0 {
            fmt.Println(num, "is negative")
        } else if num < 10 {
            fmt.Println(num, "has 1 digit")
        } else {
            fmt.Println(num, "has multiple digits")
        }
    }

swith 用法也與C 相同

    package main

    import (
        "fmt"
        "time"
    )

    func main() {

        i := 2
        fmt.Print("Write ", i, " as ")
        switch i {
        case 1:
            fmt.Println("one")
        case 2:
            fmt.Println("two")
        case 3:
            fmt.Println("three")
        }

        switch time.Now().Weekday() {
        case time.Saturday, time.Sunday:
            fmt.Println("It's the weekend")
        default:
            fmt.Println("It's a weekday")
        }

        t := time.Now()
        switch {
        case t.Hour() < 12:
            fmt.Println("It's before noon")
        default:
            fmt.Println("It's after noon")
        }

        whatAmI := func(i interface{}) {
            switch t := i.(type) {
            case bool:
                fmt.Println("I'm a bool")
            case int:
                fmt.Println("I'm an int")
            default:
                fmt.Printf("Don't know type %T\n", t)
            }
        }
        whatAmI(true)
        whatAmI(1)
        whatAmI("hey")
    }

參考網站: gobyexample

Windows中Golang docker + go.mod

JU DaDao — Wed, 21 Feb 2024 09:20:33 +0000

圖文版
如何使用docker來完成go的安裝。這篇文章會示範純粹安裝golang docker然後執行本地端定義的module

大綱

創建基本的docker file，創建golang image(optional)
將當前資料夾掛載進container下的app/ folder
執行go init 將go.mod 路徑設為/app
新增module package
main.go import
執行

Create image

首先先創建基本的docker file

FROM golang:latest #拉取golang docker

WORKDIR /app

EXPOSE 3000

Create container & mount your local folder

可以創建bat檔(windows)來快速執行。第一行創建完image後就沒用了因此可以註記掉。第二可以選擇自己正在工作的資料夾，將他移入docker 的/app底下(-v 為mount，mout進去後本機端跟docker端的資料會同步)。
假設目前的資夾叫做golen，將go len掛載到container下的/app

docker build -t judd/golan .

docker run -it -d -v D:\perProject\golen:/app --name goMoxa judd/golan

Enter container

創建好之後可以進入docker中

如果是linux 可以輸入attach 查看
如果windows直接點選圖形介面

之後點選Exec進入command line。個人習慣會輸入"/bin/bash"。這樣可以快速的使用所有bash快捷，例如上鍵可以快速存取上一個輸入的指令。

set go.mod

進入container後輸入以下指令，因為我在container中的workspace 是在/app底下，因此init選在/app

go mod init /app

go mod init必須要是你的working base非常重要(在此docker 中就是之前設定的/app)，不然當docker進行編譯的時候會去找container 中go 的資料夾

而 go.mod內的內容，代表當go 編譯的時候會去/app底下撈module

以下是go.mod內容。module路徑被設為/app底下

//go.mod
module app

go 1.22.0

Add new module

接著開始創建module，我將module都放入src資料夾中並創建名為"hello"的module。
(也可以不用放在src內，只需要以app/作為root dir import package即可，Ex. 若此module是放在main.go同層級，在main.go import hello package只需要將import "app/src/hello"改成import "app/hello"即可)

此時資料結構如下

-app/
   - go.mod
   - src/
      - hello/
          - hello.go

hello.go的內容

package hello



import "fmt"



func PrintHello() {

fmt.Println("hello world")

}

main.go import package

創建要執行的主程式main.go，使用名為"hello"的package。以下是main.go內容

//main.go
package main

import (

"app/src/hello" // 引入本地的 hello package

)



func main() {

// 調用 hello 模組中的 PrintHello 函式

hello.PrintHello()

}

此時的docker內資料夾結構

-app/
   - main.go
   - go.mod
   - src/
      - hello/
          - hello.go

Run

接著在docker 內cd 到app/底下執行

go run main.go

Docker mount Local folder

JU DaDao — Tue, 20 Feb 2024 08:56:35 +0000

Docker file

Dokcer file用來根據自己的需求從既有的image 創建新的image

建立docker file

# 建立資料夾
mkdir pro_dock
cd pro_dock

於目標資料夾中撰寫docker file，直接創建檔案，檔案名為Dockerfile，沒有副檔名。

以下示簡單的Dockerfile

# 下載指定的python 版本
FROM python:3.9-slim

# 指定工作目錄，之後創建container後資料會在其中進行處理
WORKDIR /code

如果希望從，從這邊開始整體的安裝環境已經設置好。可以安置需要的程式

可以跑

RUN {執行需要的指令，如同在CMD中的指令}
# ex. RUN apt-get update && apt-get install -y python2.7

如果希望從檔案中安裝，而不是一個個慢慢裝，可以準備一個requirements.txt

requirements.txt : (以flask為例子)

Flask==1.1.1
gunicorn==20.1.0

RUN pip install -r requirements.txt

實用技巧

一般來說docker內部，頃向不讓人永久保存資料在container中，因此大部分都會希望資料是在本機端的電腦中，而container處理環境問題。

為了將本機端的資料在container內能使用必須要有兩個

mount: 將本機端的資料夾掛載進去container
ln: (非必須)建立symbol link，在大型專案之中因為各module拆開，就算資料夾mount進去，你也不希望自己的folder汙染到現有的結構。因此從gitlab 或是github clone下來之後。在外部創建資料夾之後ln進去。

在一般的mout中

docker run -it -d -v (computer dir}:{container dir} --name {container name}

可以將指定的本機端位置，掛載到指定的container 的dir

接著建立ln，進入docker container中

cd {你希望建立ln的資料夾}

ln -s {你mount進去，想要建立ln的原始資料夾位置}

CICD Runer vs excutor

JU DaDao — Tue, 20 Feb 2024 05:33:48 +0000

CICD可以分為兩個部分CI（Continuous Integration）以及CD（Continuous Deployment）。使用者藉由將Code push至server，同時做到Test後deploy。在server上會創建Docker container來處理Push的code。此篇文章會專注介紹CI的流程以及gitlab 基礎的CICD yaml。

將使用者push code後的流程，定義為三個腳色分別為: Gitlab, runner以及excutor

當使用者push code後會觸發CICD pipeline，而cicd pipeline會去讀取gitlab yaml，得知目前pipeline中該做哪些工作。並且呼叫gitlab runner接下這些工作，runner會依工作的類型選擇不同的excutor

JWT in RTOS

JU DaDao — Thu, 25 Jan 2024 10:02:23 +0000

JWT(JSON Web Token) 在IOT常被使用的Token協定。因為其具有方便製作以及高安全性被廣泛使用各種裝置認證。這篇文章主旨是在RTOS mbed環境中，使用open ssl從KEY pair的生成到使用KEY簽屬JWT，之後再使用Public key認證JWT token

JWT的組成

JWT可以分為三個部分組成，分別為:header.payload.signature

Mbed JWT tutorial

zephyer environment

open one thread to run jwt ， this article only foucus on how zephyer jwt used. ### 1. Open ssl - Key pair generate create key use mbedtls header

#include <mbedtls/pk.h>
#include "mbedtls/entropy.h"
#include <mbedtls/rsa.h>
#include <mbedtls/sha256.h>

Gen private key
Gen key pair

#use for random seed
static int csprng_wrapper(void *ctx, unsigned char *dest, size_t size)
{
    ARG_UNUSED(ctx);
    return sys_csrand_get((void *)dest, size);
}

void create_rsa_keys(mbedtls_pk_context *private_key) 
{
    mbedtls_entropy_context entropy;
    mbedtls_ctr_drbg_context ctr_drbg;
    mbedtls_entropy_init(&entropy); #進行初始化
    mbedtls_ctr_drbg_init(&ctr_drbg); #進行亂數的初始化
    const char *pers = "test pers for test" # 設置pers
    const char *msg = "test msg for test" #設置msg

    int ret = mbedtls_ctr_drbg_seed(&ctr_drbg, csprng_wrapper, NULL ,(const unsigned char *)pers, strlen(pers));#封裝生成key 的seed
    ret = mbedtls_pk_setup(private_key, mbedtls_pk_info_from_type(MBEDTLS_PK_RSA));#輸入的位置初始化為儲存private key的空間
   mbedtls_rsa_gen_key(mbedtls_pk_rsa(*private_key), csprng_wrapper, NULL, 2048, 65537); #產生private key後儲存
   printf("\r\nKey generation %s\r\n", ret == 0 ? "successful" : "failed");
   ret = mbedtls_rsa_check_privkey(mbedtls_pk_rsa(*private_key)); #check private key 是否合法
   printf("\r\n check private key sucessfully %s\r\n", ret == 0 ? "successful" : "failed");
   mbedtls_ctr_drbg_free(&ctr_drbg); #釋放空間
   mbedtls_entropy_free(&entropy); #釋放空間

 }

因為public key可以快速地從private key中取得。在mbedtls中有兩組函數

mbedtls_pk_parse_key(&pri_key, private_pem_buf, strlen(private_pem_buf) + 1, NULL, 0, csprng_wrapper, NULL);
#此函數的pk不代表private key，因此函數將同時撈出private key and public key儲存到第一個你指定的空間中，private_pem_buf則是你存放的private key

mbedtls_pk_parse_public_key(); # 而此函數直接提取public key

2. Mbed JWT - Create JWT token

Use mbed JWT lib
Use private key sign Token

3. Token verify

use Public key verify