[譯]C# 7系列，Part 8: in Parameters in參數

来源:https://www.cnblogs.com/wenhx/archive/2019/12/20/csharp-7-series-part-8-in-parameters.html
-Advertisement-
Play Games

原文：https://blogs.msdn.microsoft.com/mazhou/2018/01/08/c-7-series-part-8-in-parameters/ 背景 預設情況下，方法參數是通過值傳遞的。也就是說，參數被覆制並傳遞到方法中。因此，修改方法體中的參數不會影響原始值。在大多數 ...


原文：https://blogs.msdn.microsoft.com/mazhou/2018/01/08/c-7-series-part-8-in-parameters/

背景

預設情況下，方法參數是通過值傳遞的。也就是說，參數被覆制並傳遞到方法中。因此，修改方法體中的參數不會影響原始值。在大多數情況下，修改是不必要的。

其他編程語言，如C++，有一個const參數或類似的概念：這表明方法體中的參數是一個不能被重新賦值的常量。它有助於避免在方法體內無意中重新賦值一個方法參數的錯誤，並通過不允許不必要的賦值來提高性能。

C# 7.2引入了in參數（又名，只讀的引用參數。) 帶有in修飾符的方法參數意味著該參數是引用且在方法體中只讀。

in參數

讓我們以下麵的方法定義為例。

public int Increment(int value)
{
    //可以重新賦值，變數value是按值傳遞進來的。
    value = value + 1;
    return value;
}

若要創建只讀引用參數，請在參數前增加in修飾符。

public int Increment(in int value)
{
    //不能重新賦值，變數value是只讀的。
    int returnValue = value + 1;
    return returnValue;
}

如果重新賦值，編譯器將生成一個錯誤。

可以使用常規方法來調用這個方法。

int v = 1;
Console.WriteLine(Increment(v));

因為value變數是只讀的，所以不能將value變數放在等式左邊(即LValue)。執行賦值的一元運算符也是不允許的，比如++或--。但是，你仍然可以獲取值的地址並使用指針操作進行修改。

解決重載

in是一個方法參數的修飾符，它表明此參數是引用類型，它被視為方法簽名的一部分。這意味著你可以有兩個方法重載，只是in修飾符不同。（譯註：一個有in，一個沒有in）

下麵的代碼示例定義了兩個方法重載，只是引用類型不同。

public class C
{
    public void A(int a)
    {
        Console.WriteLine("int a");
    }

    public void A(in int a)
    {
        Console.WriteLine("in int a");
    }
}

預設情況下，方法調用將解析為值簽名的那個重載。為了清除歧義並顯式地調用引用簽名的重載，在顯式地調用A(in int)方法重載時，在實際的參數之前加上in修飾符。

private static void Main(string[] args)
{
    C c = new C();
    c.A(1); // A(int)
    int x = 1;
    c.A(in x); // A(in int)
    c.A(x); // A(int)
}

程式輸出如下：

限制

因為in參數是只讀的引用參數，所以所有引用參數的限制都適用於in。

  • 不能用於迭代器方法(即具有yield語句的方法)。
  • 不能用於async非同步方法。
  • 如果你用in修飾Main方法的args參數，則入口點的方法簽名會無效。

in參數和CLR

在.NET的CLR中已經有了一個類似的概念，所以in參數特性不需要改變CLR。

任何in參數在被編譯成MSIL時，都會在定義中附加一個[in]指令。為了觀察編譯行為，我使用ILDAsm.exe獲得上面示例反編譯的MSIL。

下麵的MSIL代碼是方法C.A(int)：

.method public hidebysig instance void  A(int32 a) cil managed

{
   // Code size       13 (0xd)
   .maxstack  8
   IL_0000:  nop
   IL_0001:  ldstr      "int a"
   IL_0006:  call       void [System.Console]System.Console::WriteLine(string)
   IL_000b:  nop
   IL_000c:  ret

} // end of method C::A

下麵的MSIL代碼是方法C.A(in int)：

.method public hidebysig instance void  A([in] int32& a) cil managed

{
   .param [1]
   .custom instance void [System.Runtime]System.Runtime.CompilerServices.IsReadOnlyAttribute::.ctor() = ( 01 00 00 00 ) 
   // Code size       13 (0xd)
   .maxstack  8
   IL_0000:  nop
   IL_0001:  ldstr      "in int a"
   IL_0006:  call       void [System.Console]System.Console::WriteLine(string)
   IL_000b:  nop
   IL_000c:  ret

} // end of method C::A

你看到區別了嗎？int32&顯示它是一個引用參數；[in]是一個指示CLR如何處理此參數的附加元數據。

下麵的代碼是上面例子中Main方法的MSIL，它展示瞭如何調用這兩個C.A()方法的重載。

.method private hidebysig static void  Main(string[] args) cil managed

{
   .entrypoint
   // Code size       35 (0x23)
   .maxstack  2
   .locals init (class Demo.C V_0,
            int32 V_1)
   IL_0000:  nop
   IL_0001:  newobj     instance void Demo.C::.ctor()
   IL_0006:  stloc.0
   IL_0007:  ldloc.0
   IL_0008:  ldc.i4.1
   IL_0009:  callvirt   instance void Demo.C::A(int32)
   IL_000e:  nop
   IL_000f:  ldc.i4.1
   IL_0010:  stloc.1
   IL_0011:  ldloc.0
   IL_0012:  ldloca.s   V_1
   IL_0014:  callvirt   instance void Demo.C::A(int32&)
   IL_0019:  nop
   IL_001a:  ldloc.0
   IL_001b:  ldloc.1
   IL_001c:  callvirt   instance void Demo.C::A(int32)
   IL_0021:  nop
   IL_0022:  ret

} // end of method Program::Main

在調用點，沒有其他元數據指示去調用C.A(in int)。

in參數和互操作

在許多地方，[In]特性被用於與本機方法簽名匹配以實現互操作性。讓我們以下麵的Windows API為例。

[DllImport("shell32")]
public static extern int ShellAbout(
    [In] IntPtr handle,
    [In] string title,
    [In] string text,
    [In] IntPtr icon);

此方法對應的MSIL如下所示。

.method public hidebysig static pinvokeimpl("shell32" winapi) 
         int32  ShellAbout([in] native int handle,
                           [in] string title,
                           [in] string text,
                           [in] native int icon) cil managed preservesig

如果我們使用in修飾符來改變ShellAbout方法的簽名：

[DllImport("shell32")]
public static extern int ShellAbout(
    in IntPtr handle,
    in string title,
    in string text,
    in IntPtr icon);

該方法生成的MSIL為：

.method public hidebysig static pinvokeimpl("shell32" winapi) 
         int32  ShellAbout([in] native int& handle,
                           [in] string& title,
                           [in] string& cext,
                           [in] native int& icon) cil managed preservesig

{
   .param [1]
   .custom instance void [System.Runtime]System.Runtime.CompilerServices.IsReadOnlyAttribute::.ctor() = ( 01 00 00 00 ) 
   .param [2]
   .custom instance void [System.Runtime]System.Runtime.CompilerServices.IsReadOnlyAttribute::.ctor() = ( 01 00 00 00 ) 
   .param [3]
   .custom instance void [System.Runtime]System.Runtime.CompilerServices.IsReadOnlyAttribute::.ctor() = ( 01 00 00 00 ) 
   .param [4]
   .custom instance void [System.Runtime]System.Runtime.CompilerServices.IsReadOnlyAttribute::.ctor() = ( 01 00 00 00 ) 

}

正如你所看到的，編譯器為每個in參數產生了使用[in]指令、引用數據類型和[IsReadOnly]特性的代碼。由於參數已從傳值更改為傳引用, P/Invoke可能會由於原始簽名不匹配而失敗。

結論

in參數是擴展C#語言的一個很棒的特性，它易於使用，並且是二進位相容的(不需要對CLR進行更改)。只讀引用參數在修改只讀參數時給出編譯時錯誤，有助於避免錯誤。這個特性可以與其他ref特性一起使用，比如引用返回和引用結構。

 

系列文章：


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • C#泛型學習筆記
    一、什麼是泛型 泛型是C#2.0推出的新語法，不是語法糖，而是2.0由框架升級提供的功能。泛型類就類似於一個模板，可以在需要時為這個模板傳入任何我們需要的類型。 二、為什麼使用泛型 下麵代碼演示輸出幾種類型的相關信息： class Program { /// <summary> /// 列印幫助類 ...
  • 基於C# WPF框架的貪吃蛇
    游戲開始界面 游戲開始 共有兩條蛇，吃到紅色食物加1分，吃到綠色毒食物減1分，知道0不減； 碰到牆壁游戲結束，碰到對方游戲結束，碰到自己游戲結束 此游戲通過Canvas畫布佈局，通過C 代碼實現 游戲主界面大小為1200 1000 全局聲明： 載入事件： 開啟游戲按鈕 暫停按鈕 創建食物方法： 游戲 ...
  • 基於C# WinForms窗體——飛機大戰
    ![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20191118171503872.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nL... ...
  • C# 模擬瀏覽器並自動操作
    本文主要講解通過WebBrowser控制項打開頁面，並自動輸入實現搜索功能，僅供學習分享使用，如有不足之處，還請指正。 ...
  • C#8.0中新特性之一：結構readonly成員
    結構struct成員支持readonly，用來限制被其修飾的成員不會改變結構的內部狀態。加上7.2版本添加的readonly struct和ref readonly方法返回以及之前的欄位聲明修飾作用，現在readonly一共有四種修飾作用。下麵兩段代碼以及註釋進行了說明。 //(v8.0)reado ...
  • 從頭實現一個WPF條形圖
    時間如流水，只能流去不流回！ 點贊再看，養成習慣，這是您給我創作的動力！ 本文 Dotnet9 https://dotnet9.com 已收錄，站長樂於分享dotnet相關技術，比如Winform、WPF、ASP.NET Core等，亦有C++桌面相關的Qt Quick和Qt Widgets等，只分 ...
  • Teigha.net實體屬性註釋
    Polyline3d: 3D polyline的類型由PolyType屬性存儲， 它是由Poly3dType枚舉定義的整數值。PolyType屬性是一種繪製三維折線的近似方法 Polyline3d polyline = new Polyline3d(Poly3dType.SimplePoly, p3 ...
  • Asp.Net MVC中Aplayer.js音樂播放器的使用
    聽到一首歌就想起那段時間的記憶，今天就研究一下Aplayer.js這個音樂播放器，以後手氣老歌用自己弄得播放器聽那才叫爽！ ...
一周排行
    -Advertisement-
    Play Games
  • WPF 已知問題 監聽 WMI 事件導致觸摸失效
    示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後，項目結構如下所示： MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread]特性
    [STAThread] 特性用於需要與 COM 組件交互的應用程式，尤其是依賴單線程模型（如 Windows Forms 應用程式）的組件。在 STA 模式下，線程擁有自己的消息迴圈，這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • UWP WinUI3 傳入 AddHandler 的 RoutedEventHandler 類型與事件所需不匹配將拋出參數異常
    在WinForm中使用全局異常捕獲處理 在WinForm應用程式中，全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理，可以有效地捕獲並處理未預見的異常，從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • .NET 多版本 WinForm 開源控制項庫 SunnyUI
    前言 給大家推薦一款開源的 Winform 控制項庫，可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫，同時也提供了工具類庫、擴展 ...
  • .net core8 使用Swagger（附當前源碼）
    說明 該文章是屬於OverallAuth2.0系列文章，每周更新一篇該系列文章（從0到1完成系統開發）。 該系統文章，我會儘量說的非常詳細，做到不管新手、老手都能看懂。 說明：OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友，請關註我吧(*^▽^*) ...
  • WPF 什麼時候 VisualTreeHelper.GetDescendantBounds 將返回無窮大
    一、下載安裝 1.下載git 必須先下載並安裝git，再TortoiseGit下載安裝 git安裝參考教程：https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit，Git客戶端，32/6 ...
  • C# 開源教程帶你輕鬆掌握數據結構與演算法
    前言 在項目開發過程中，理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼，還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程：Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 第22篇 生成proto文件bat腳本
    1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 記一次 .NET某上位機視覺程式 卡死分析
    一：背景 1. 講故事 前段時間有位朋友找到我，說他的窗體程式在客戶這邊出現了卡死，讓我幫忙看下怎麼回事？dump也生成了，既然有dump了那就上 windbg 分析吧。 二：WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死，入口門檻很低，後續往下分析就不一定了，不管怎麼說先用 !clrsta ...
  • 醫學DICOM文件與PACS系統進行數據傳輸
    前言 人工智慧時代，人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API，工具不僅易於集成，還具備高效處理能力。 本文將介紹一款如何利用這些API，為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...
所有分類