主頁 > .NET開發 > 包名和變數是否應該避免陰影?

包名和變數是否應該避免陰影?

2021-10-27 22:57:17 .NET開發

測驗代碼中有很多示例隱藏了 testify 等測驗庫中的包名稱。

例如:

import (
  "testing"
  "github.com/stretchr/testify/assert"
  "github.com/stretchr/testify/require"
)

func TestSomething(t *testing.T) {
  assert := assert.New(t)
  require := require.New(t)
  var a string = "Hello"
  var b string = "Hello"

  assert.Equal(a, b, "The two words should be the same.")
}

用區域變數覆寫包命名空間的值不應該是一個明確的決定并且很少發生嗎?

import (
  "testing"
  "github.com/stretchr/testify/assert"
  "github.com/stretchr/testify/require"
)

func TestSomething(t *testing.T) {
  assertions := assert.New(t)
  req := require.New(t)
  var a string = "Hello"
  var b string = "Hello"

  assert.Equal(a, b, "The two words should be the same.")
}

我希望正確的行為是為包添加別名,就像pkgassert我覺得不習慣的那樣,或者確保變數沒有設定為與包相同的名稱:assertions := assert.New(t).

其他例子:

  • 好的: buf := bytes.Buffer{}
  • 壞的: bytes := bytes.Buffer{}

注意:我不關注變數命名模式,因為 Go 傾向于推薦單個字母,或者在您可能使用緩沖區的狹窄范圍內使用短變數。由于函式長度,假設更長的名稱是可以接受和需要的。

如果這是測驗包中所需的行為,我想知道為什么?它似乎違反了 Go 在“無魔法”和可讀性方面的一個關鍵原則。

如果由此產生不良副作用,我也想知道。我的假設是這意味著在匯入后,由于變數陰影,對同一范圍內的包的任何呼叫都將不起作用

編輯

Go中的Scope Shadowing是一本不錯的讀物,并在使用方面給出了一些很好的觀點。我從這篇文章和 Stack 評論者那里得到的主要收獲:

  1. 可以增強可讀性。(我認為這可能是因為 Go 更喜歡對包進行簡潔的命名,在 Go 中使用可變長度的包名稱。)

  2. Parallel Test Issues was something I recall reading a while back. I didn't understand the recommendation to "hide" the loop variable by putting in:

     for _, tc := range tests {
         tc := tc
         t.Run(tc.name, func(t *testing.T) {
             t.Parallel()
             // Here you test tc.value against a test function.
             // Let's use t.Log as our test function :-)
             t.Log(tc.value)
         })
     }
    

    }

With a better understanding of shadowing, I'm seeing this "hiding" was talking about shadowing the caller scope variable of tc by assigning inside the loop, thereby shadowing.

This seems like a good use case, though I still feel it is being "clever" rather if not commented, and violates the idiomatic Go goals of being clear and readable with no "magic".

uj5u.com熱心網友回復:

哇,這是可怕的代碼。雖然它可能不是編譯器強制規則,但如果我看到這個:

import "github.com/stretchr/testify/assert"

然后在該檔案中,就我而言,任何拼寫assert識別符號都是該包中的頂級匯入,句點。任何打破這種模式的人,以“聰明”之類的名義,都是自找麻煩。人們的肌肉記憶被訓練來識別頂級進口,所以請不要做這樣的事情。如果您想避免想到新名稱,只需洗掉一些字母:

asrt := assert.New(t)

或添加一個字母:

nAssert := assert.New(t)

或別名匯入:

import tAssert "github.com/stretchr/testify/assert"

請不要遵循該代碼中給出的糟糕示例。

uj5u.com熱心網友回復:

在查看了所有反饋和寫作之后,我將在這里總結調查結果。

如果您在看到來自 Goland 之類的工具的 Go linting 警報后正在調查此行為,希望這個答案可以為您節省相同的時間,并明確表示這是可以的、慣用的,并且僅在某些情況下在初始化后重用實際的包呼叫才會有任何問題有經驗。

使用區域變數隱藏包名稱

  • 這是一個見仁見智的問題,沒有官方宣告表明這被認為是非慣用代碼。

  • 除非為了清晰和可讀性而有意這樣做,否則意見總體上傾向于避免陰影,但這又是意見,而不是要求。

  • 一旦被覆寫,包將在該范圍內不可用,因為包名稱已被區域變數遮蔽。

  • 我觀察到這種行為在 Go 中似乎比在某些語言中更可能發生,因為 Go 提示的包名稱很短,不是多詞,并且易于輸入。assert := assert.New(t)當這種情況發生時,這似乎是不可避免的

  • 與往常一樣,在此類問題中,一致性是關鍵。如果團隊決定從不隱藏包名稱,則assertions := assert.New(t)可以使用 ,或者如前所述,包可以使用別名,例如import tassert "github.com/stretchr/testify/assert". 這是一種意見標準,無論哪種方式都是合法的并且被認為是慣用的。

  • 在測驗的情況下,這通常是在初始變數集不再使用后進一步使用包而完成的。下面使用is is 包的示例包作者對此發表評論(這也是固執己見,但與is := is.New(t).

package package_test

import (
    "testing"
    "package"
    
    iz "github.com/matryer/is"
)

func TestFuncName(t *testing.T) {
    is := iz.New(t)
    
    got := FuncName()
    want := ""
    
    is.Equal(got,want) // AssertMessage
}

陰影行為可以解決 Goroutine 變數問題

陰影是一種已知的行為,并在Effective Go 中有明確記錄

錯誤在于在 Go for 回圈中,回圈變數在每次迭代中都被重用,因此 req 變數在所有 goroutine 之間共享。那不是我們想要的。

req := req起來可能很奇怪,但在 Go 中這樣做是合法和慣用的。你會得到一個同名變數的新版本,故意在本地隱藏回圈變數,但每個 goroutine 都是唯一的。

這可以通過將變數作為引數傳遞到嵌入式 func 中來解決,而無需隱藏,從而簡化代碼。根據指南,兩者都是合法的并且被認為是慣用的。

測驗陰影

與此 goroutine 行為相關,但在測驗的背景關系中,并行測驗在 goroutine 中運行,因此也可以從這種模式中受益。

The tc := tc statement is required in the parallel test example because the closure runs in a goroutine. More generally, the tc := tc idiom used in the context of closures where the closure can be executed after the start of the next loop iteration - credit @gopher in comments

The gist on Be Careful With Table Driven Tests mentions this behavior as well in the How To Solve This.

Detecting

The check go vet can check for shadowing, but is not considered part of the stable package, and was removed here related to GitHub Issue 29260 and GitHub Issue 34053. The change seems to have been prompted for compatibility purposes due to the requirement of unsafeptr flag. Additional comments seem to point towards also requiring better heuristics before allowing in go vet without being experimental.

  • Go Vet Shadow
  • Instructions on running via go vet: Package Variables With Instructions:
go install golang.org/x/tools/go/analysis/passes/shadow/cmd/shadow
go vet -vettool=$(which shadow)

For those wanting to lint this, golangci-lint does have an option to configure shadowing checks in the configuration (search for check-shadowing as no bookmark to that text block`.

Further Reading

  • Scope and Shadowing in Go
  • Scopes and Closures

轉載請註明出處,本文鏈接:https://www.uj5u.com/net/338495.html

標籤:go

上一篇:自動滾動FyneTextGrid中的日志文本

下一篇:模板無法正確決議嵌入FS

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • WebAPI簡介

    Web體系結構: 有三個核心:資源(resource),URL(統一資源識別符號)和表示 他們的關系是這樣的:一個資源由一個URL進行標識,HTTP客戶端使用URL定位資源,表示是從資源回傳資料,媒體型別是資源回傳的資料格式。 接下來我們說下HTTP. HTTP協議的系統是一種無狀態的方式,使用請求/ ......

    uj5u.com 2020-09-09 22:07:47 more
  • asp.net core 3.1 入口:Program.cs中的Main函式

    本文分析Program.cs 中Main()函式中代碼的運行順序分析asp.net core程式的啟動,重點不是剖析原始碼,而是理清程式開始時執行的順序。到呼叫了哪些實體,哪些法方。asp.net core 3.1 的程式入口在專案Program.cs檔案里,如下。ususing System; us ......

    uj5u.com 2020-09-09 22:07:49 more
  • asp.net網站作為websocket服務端的應用該如何寫

    最近被websocket的一個問題困擾了很久,有一個需求是在web網站中搭建websocket服務。客戶端通過網頁與服務器建立連接,然后服務器根據ip給客戶端網頁發送資訊。 其實,這個需求并不難,只是剛開始對websocket的內容不太了解。上網搜索了一下,有通過asp.net core 實作的、有 ......

    uj5u.com 2020-09-09 22:08:02 more
  • ASP.NET 開源匯入匯出庫Magicodes.IE Docker中使用

    Magicodes.IE在Docker中使用 更新歷史 2019.02.13 【Nuget】版本更新到2.0.2 【匯入】修復單列匯入的Bug,單元測驗“OneColumnImporter_Test”。問題見(https://github.com/dotnetcore/Magicodes.IE/is ......

    uj5u.com 2020-09-09 22:08:05 more
  • 在webform中使用ajax

    如果你用過Asp.net webform, 說明你也算是.NET 開發的老兵了。WEBform應該是2011 2013左右,當時還用visual studio 2005、 visual studio 2008。后來基本都用的是MVC。 如果是新開發的專案,估計沒人會用webform技術。但是有些舊版 ......

    uj5u.com 2020-09-09 22:08:50 more
  • iis添加asp.net網站,訪問提示:由于擴展配置問題而無法提供您請求的

    今天在iis服務器配置asp.net網站,遇到一個問題,記錄一下: 問題:由于擴展配置問題而無法提供您請求的頁面。如果該頁面是腳本,請添加處理程式。如果應下載檔案,請添加 MIME 映射。 WindowServer2012服務器,添加角色安裝完.netframework和iis之后,運行aspx頁面 ......

    uj5u.com 2020-09-09 22:10:00 more
  • WebAPI-處理架構

    帶著問題去思考,大家好! 問題1:HTTP請求和回傳相應的HTTP回應資訊之間發生了什么? 1:首先是最底層,托管層,位于WebAPI和底層HTTP堆疊之間 2:其次是 訊息處理程式管道層,這里比如日志和快取。OWIN的參考是將訊息處理程式管道的一些功能下移到堆疊下端的OWIN中間件了。 3:控制器處理 ......

    uj5u.com 2020-09-09 22:11:13 more
  • 微信門戶開發框架-使用指導說明書

    微信門戶應用管理系統,采用基于 MVC + Bootstrap + Ajax + Enterprise Library的技術路線,界面層采用Boostrap + Metronic組合的前端框架,資料訪問層支持Oracle、SQLServer、MySQL、PostgreSQL等資料庫。框架以MVC5,... ......

    uj5u.com 2020-09-09 22:15:18 more
  • WebAPI-HTTP編程模型

    帶著問題去思考,大家好!它是什么?它包含什么?它能干什么? 訊息 HTTP編程模型的核心就是訊息抽象,表示為:HttPRequestMessage,HttpResponseMessage.用于客戶端和服務端之間交換請求和回應訊息。 HttpMethod類包含了一組靜態屬性: private stat ......

    uj5u.com 2020-09-09 22:15:23 more
  • 部署WebApi隨筆

    一、跨域 NuGet參考Microsoft.AspNet.WebApi.Cors WebApiConfig.cs中配置: // Web API 配置和服務 config.EnableCors(new EnableCorsAttribute("*", "*", "*")); 二、清除默認回傳XML格式 ......

    uj5u.com 2020-09-09 22:15:48 more
最新发布
  • C#多執行緒學習(二) 如何操縱一個執行緒

    <a href="https://www.cnblogs.com/x-zhi/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/2943582/20220801082530.png" alt="" /></...

    uj5u.com 2023-04-19 09:17:20 more
  • C#多執行緒學習(二) 如何操縱一個執行緒

    C#多執行緒學習(二) 如何操縱一個執行緒 執行緒學習第一篇:C#多執行緒學習(一) 多執行緒的相關概念 下面我們就動手來創建一個執行緒,使用Thread類創建執行緒時,只需提供執行緒入口即可。(執行緒入口使程式知道該讓這個執行緒干什么事) 在C#中,執行緒入口是通過ThreadStart代理(delegate)來提供的 ......

    uj5u.com 2023-04-19 09:16:49 more
  • 記一次 .NET某醫療器械清洗系統 卡死分析

    <a href="https://www.cnblogs.com/huangxincheng/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/214741/20200614104537.png" alt="" /&g...

    uj5u.com 2023-04-18 08:39:04 more
  • 記一次 .NET某醫療器械清洗系統 卡死分析

    一:背景 1. 講故事 前段時間協助訓練營里的一位朋友分析了一個程式卡死的問題,回過頭來看這個案例比較經典,這篇稍微整理一下供后來者少踩坑吧。 二:WinDbg 分析 1. 為什么會卡死 因為是表單程式,理所當然就是看主執行緒此時正在做什么? 可以用 ~0s ; k 看一下便知。 0:000> k # ......

    uj5u.com 2023-04-18 08:33:10 more
  • SignalR, No Connection with that ID,IIS

    <a href="https://www.cnblogs.com/smartstar/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/u36196.jpg" alt="" /></a>...

    uj5u.com 2023-03-30 17:21:52 more
  • 一次對pool的誤用導致的.net頻繁gc的診斷分析

    <a href="https://www.cnblogs.com/dotnet-diagnostic/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/3115652/20230225090434.png" alt=""...

    uj5u.com 2023-03-28 10:15:33 more
  • 一次對pool的誤用導致的.net頻繁gc的診斷分析

    <a href="https://www.cnblogs.com/dotnet-diagnostic/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/3115652/20230225090434.png" alt=""...

    uj5u.com 2023-03-28 10:13:31 more
  • C#遍歷指定檔案夾中所有檔案的3種方法

    <a href="https://www.cnblogs.com/xbhp/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/957602/20230310105611.png" alt="" /></a&...

    uj5u.com 2023-03-27 14:46:55 more
  • C#/VB.NET:如何將PDF轉為PDF/A

    <a href="https://www.cnblogs.com/Carina-baby/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/2859233/20220427162558.png" alt="" />...

    uj5u.com 2023-03-27 14:46:35 more
  • 武裝你的WEBAPI-OData聚合查詢

    <a href="https://www.cnblogs.com/podolski/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/616093/20140323000327.png" alt="" /><...

    uj5u.com 2023-03-27 14:46:16 more