看似简单的问题,背后涉及了很多基础知识。

代码

 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
using System;

namespace Cs1612Demo
{
    class Program
    {
        static void Main(string[] args)
        {
            Player p = new Player();
            p.ShowLocation();

            p.Location.x = 1; // property return temp value => CS1612

            p._location.x = 2; // filed is ok

            p.ShowLocation();

            List<Point> _locations = new List<Point>();
            _locations[0].x = 3;// List indexer is just a property, and property return temp value => CS1612CS1612

            Point[] _locationsArray = new Point[]{new Point()};
            _locationsArray[0].x = 3; // array index return reference, ok

        }
    }

    struct Point
    {
        public float x;
        public float y;
    }

    class Player
    {
        public Point Location
        {
            get { return _location;}
            set { _location = value; }
        }

        public Point _location = new Point();

        public void ShowLocation()
        {
            Console.WriteLine(Location.x + "," + Location.y);
        }
    }
}

分析

上面的代码不会通过编译,错误为:

1
2
错误    CS1612    无法修改“Player.Location”的返回值,因为它不是变量*
错误    CS1612    无法修改“List<Point>.this[init]”的返回值,因为它不是变量*
  • 属性的get方法返回值类型,而不是Location的引用,由于Point是值类型,索引返回Location的副本。由于这个副本不保存在任何变量中,所以修改值并不会保存回Location变量,赋值没有意义。
  • 字段是直接在原值上操作
  • List的索引器是一个属性,同上
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    
    public T this[int index] 
    {
        get 
        {
            return _items[index]; 
        }
    
        set 
        {
            _items[index] = value;
        }
    }
    
  • CLR 从一开始就支持数组,数组的索引返回引用,类似field,是在原值上直接操作

消除错误的方法:

  1. 将Point改为class。但由于Point是 C#的内置类型,这种方法并大多数情况下并不可行。

  2. 去掉 *{ get; set; } *将Location 改为public field,这也不推荐。Property较之Field有很多优点

    • 封装底层field
    • set中可以包含验证逻辑
    • field不能用于绑定
  3. 如前所述,return _location返回的是一个临时副本,对其修改没意义。那我们就先把它赋给一个变量,修改后再赋回去:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    
     //p.Location.x = 6; // 报错 CS1612
     //p.Location.y = 2; // 报错 CS1612
     var location = p.Location;
     location.x = 6;
     location.y = 2;
     p.Location = location;
    
     var temp = _locations[0];
     temp.x = 3;
     _locations[0] = temp;
    
  4. 有的struct很大,为了避免按值传递带来的性能损耗,C# 7.0新增了ref returns,允许开发者返回值类型的引用,并直接对其修改:

     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
    
    using System;
    
     namespace Cs1612Demo
     {
         class Program
         {
             static void Main(string[] args)
             {
                 Player p = new Player();
                 p.ShowLocation();
                 p.Location.x = 6;
                 p.Location.y = 2;
                 p.ShowLocation();
             }
         }
    
         struct Point
         {
             public float x;
             public float y;
         }
    
         class Player
         {
             Point _location;
    
             public ref Point Location { get { return ref _location; } }
    
             public void ShowLocation()
             {
                 Console.WriteLine(Location.x + "," + Location.y);
             }
         }
    

这样,返回的就是_location 的引用,可以像上面改成class一样修改了。注意这里需要去掉setter,否则会报错误" CS8147 按引用返回的属性不能有 set 访问器 “。因为返回的是引用,可以任意修改,也就没有必要保留set访问器了。

参考链接

Compiler Error CS1612

Ref returns and ref locals

What’s new in C# 7.0

C# 7 Series, Part 7: Ref Returns

Performance traps of ref locals and ref returns in C#

https://stackoverflow.com/a/6705630/65994