天天看點

使用 Goland 開發 dubbogo 項目時如何自動快速格式化 import 代碼塊

dubbogo 項目每個 import 代碼塊都是如下組織格式:

import (  
"go内置包"  
)  
  
import (  
"第三方包"  
)  
  
import (  
"目前項目的包"  
)      

後來社群的 committer 董劍輝同學開發了一個指令行工具 imports-formatter,用于整理代碼 imports 塊,本文主要介紹如何在 goland 中加載這個工具,自動把你的項目的 import 代碼塊格式化成 dubbogo 風格。

一、dubbogo-cli 工具介紹

相較 goimports,imports-formatter 更易讀、更規範。它将 imports 塊分成上中下三塊:最上面那塊是 Go SDK 自有包,中間塊是第三方包,最下面那塊則是目前項目自身的包。如下所示:

package main

import (
  "context"
)

import (
  "dubbo.apache.org/dubbo-go/v3/common/logger"
  "dubbo.apache.org/dubbo-go/v3/config"
  _ "dubbo.apache.org/dubbo-go/v3/imports"
)

import (
  "github.com/apache/dubbo-go-samples/api"
)      

二、安裝 dubbogo-cli 工具

dubbogo-cli 是 Apach/dubbo-go 生态的子項目,為開發者提供便利的應用模闆建立、工具安裝、接口調試等功能,以提高使用者的研發效率。 執行以下指令安裝dubbogo-cli 至 $GOPATH/bin

go install github.com/dubbogo/dubbogo-cli@latest      

三、使用 dubbogo-cli 工具安裝 imports-formatter 工具

dubbogo-cli install all      

四、Goland 內建 imports-formatter 工具

1、打開 Goland 後,按下 Ctrl + Alt + s 快捷鍵以打開 Goland 設定。按下圖添加 goimports 後點選 OK :

使用 Goland 開發 dubbogo 項目時如何自動快速格式化 import 代碼塊

2、在彈出的對話框中按下圖紅色箭頭依次填寫,然後點選 OK 完成配置:

五 關注社群