可惜Java中没有yield return

Published: by Creative Commons Licence

项目中一个消息推送需求,推送的用户数几百万,用户清单很简单就是一个txt文件,是由hadoop计算出来的。格式大概如下:

uid  caller
123456  12345678901
789101  12345678901

现在要做的就是读取文件中的每一个用户然后给他推消息,具体的逻辑可能要复杂点,但今天关心的是如何遍历文件返回用户信息的问题。

之前用C#已经写过类似的代码,大致如下:

/// <summary>
        /// 读取用户清单列表,返回用户信息。
        /// </summary>
        /// <param name="parameter">用户清单文件路径</param>
        /// <param name="position">推送断点位置,用户断点推送</param>
        /// <returns></returns>
        public IEnumerable<UserInfo> Provide(string parameter, int position)
        {
            FileStream fs = new FileStream(parameter, FileMode.Open);
            StreamReader reader = null;
            try
            {
                reader = new StreamReader(fs);
                //获取文件结构信息
                string[] schema = reader.ReadLine().Trim().Split(' ');
                for (int i = 0; i < position; i++)
                {
                    //先空读到断点位置
                    reader.ReadLine();  
                }
                while (!reader.EndOfStream)
                {
                    UserInfo userInfo = new UserInfo();
                    userInfo.Fields = new Dictionary<string, string>();
                    string[] field = reader.ReadLine().Trim().Split(' ');
                    for (int i = 0; i < schema.Length; i++)
                    {
                        userInfo.Fields.Add(schema[i].ToLower(), field[i]);
                    }

                    yield return userInfo;
                }
            }
            finally
            {
                reader.Close();
                fs.Close();
            }
        }

代码很简单,就是读取清单文件返回用户信息,需要注意的就是标红的地方,那么yield return的作用具体是什么呢。对比下面这个版本的代码:

public IEnumerable<UserInfo> Provide2(string parameter, int position)
        {
            List<UserInfo> users = new List<UserInfo>();
            FileStream fs = new FileStream(parameter, FileMode.Open);
            StreamReader reader = null;
            try
            {
                reader = new StreamReader(fs);
                //获取文件结构信息
                string[] schema = reader.ReadLine().Trim().Split(' ');
                for (int i = 0; i < position; i++)
                {
                    //先空读到断点位置
                    reader.ReadLine();
                }
                while (!reader.EndOfStream)
                {
                    UserInfo userInfo = new UserInfo();
                    userInfo.Fields = new Dictionary<string, string>();
                    string[] field = reader.ReadLine().Trim().Split(' ');
                    for (int i = 0; i < schema.Length; i++)
                    {
                        userInfo.Fields.Add(schema[i].ToLower(), field[i]);
                    }

                    users.Add(userInfo);
                }

                return users;
            }
            finally
            {
                reader.Close();
                fs.Close();
            }
        }

本质区别是第二个版本一次性返回所有用户的信息,而第一个版本实现了惰性求值(Lazy Evaluation),针对上面的代码简单调试下,你会发现同样是通过foreach进行迭代,第一个版本每次代码运行到yield return userInfo的时候会将控制权交给“迭代”它的地方,而后面的代码会在下次迭代的时候继续运行。

static void Main(string[] args)
        {
            string filePath = @"D:\users.txt";

            foreach (var user in new FileProvider().Provide(filePath,0))
            {
                Console.WriteLine(user);
            }
        }

而第二个版本则需要等所有用户信息全部获取到才能返回。相比之下好处是显而易见的,比如前者占用更小的内存,cpu的使用更稳定:

01131056-d559bf0a08814e3cacf3676ad3ea0039.png

01131109-16c5dcebd6dd4519a7b1d42fc848a0c5.png

当然做到这点是需要付出代价(维护状态),真正的好处也并不在此。之前我在博客中对C#的yield retrun有一个简单的总结,但是并没有深入的研究:

  • IEnumerable是对IEnumerator的封装,以支持foreach语法糖。
  • IEnumerable和IEnumerator分别继承自IEnumerable和IEnumerator以提供强类型支持(即状态机中的“现态”是强类型)。
  • yield return是编译器对IEnumerator和IEnumerable实现的语法糖。
  • yield return 表现是实现IEnumerator的MoveNext方法,本质是实现一个状态机。
  • yield return能暂时将控制权交给外部,我比作“程序上奇点”,让你实现穿越。能达到目的:延迟计算、异步流。

先看第1条,迭代器模式是大部分语言都支持一个设计模式,它是一种行为模式:

行为模式是一种简化对象之间通信的设计模式。

在C#中是IEnumerator接口,Java是Iterator,且目前都有泛型版本提供,语法层面上两个接口基本是一致的。

    //C#   
    public interface IEnumerator
    {
        object Current { get; }
        bool MoveNext();
        void Reset();
    }

    //Java
    public interface Iterator<E> {
         boolean hasNext();
         E next();
         void remove();    
    }

在C#2(注意需要区别.net,c#,CLR之间的区别)之前创建一个迭代器,C#和Java的代码量是差不多的。两个语言中除了迭代器接口之外还分别提供了一个IEnumerable和Iterable接口:

    //C#
    public interface IEnumerable<out T> : IEnumerable
    {
        IEnumerator<T> GetEnumerator();
    }

    //Java
    public interface Iterable<T> {
        Iterator<T> iterator();
    }

那么它们的关系是什么呢?语法上看IEnumerable是对IEnumerator的封装,以支持foreach语法糖,但这么封装的目的是什么呢,我们的类直接实现IEnumerator接口不就行了。回答这个问题我们需要理解迭代的本质是什么。我们使用的迭代器的目的是在不知道集合内部状态的情况下去遍历它,调用者每次只想获取一个元素,所以在返回上一个值的时候需要跟踪当前的工作状态:

  • 必须具有某个初始状态。
  • 每次调用MoveNext的时候,需要维护当前的状态。
  • 使用Current属性的时候,返回生成的上一个值。
  • 迭代器需要知道何时完成生成值的操作

所以实现迭代器的本质是自己维护一个状态机,我们需要自己维护所有的内部状态,看下面一个简单的实现IEnumerator接口的例子:

public class MyEnumerator : IEnumerator
    {
        private object[] values;
        int position;

        public MyEnumerator(object[] values)
        {
            this.values = values;
            position = -1;
        }

        public object Current
        {
            get
            {
                if (position == -1 || position == values.Length)
                {
                    throw new InvalidOperationException();
                }

                return values[position];
            }
        }

        public bool MoveNext()
        {
            if (position != values.Length)
            {
                position++;
            }

            return position < values.Length;
        }

        public void Reset()
        {
            position = -1;
        }
    }
static void Main(string[] args)
        {
            object[] values = new object[] { 1, 2, 3 };
            MyEnumerator it = new MyEnumerator(values);

            while (it.MoveNext())
            {
                Console.WriteLine(it.Current);
            }
        }

这个例子很简单,也很容易实现,现在假设同时有两个线程去迭代这个集合,那么使用一个MyEnumerator对象明显是不安全的,这正是IEnumerable存在的原因,它允许多个调用者并行的迭代集合,而各自的状态独立互不影响,同时实现了foreach语法糖。这也是为什么C#中在迭代Dictionary的时候只是只读原因:

01150126-278a3df77d3e4825b5908133c1e6fbf3.png

增加一个IEnumerable并没有使问题变的很复杂:

public class MyEnumerable : IEnumerable
    {
        private object[] values;

        public MyEnumerable(object[] values)
        {
            this.values = values;
        }

        public IEnumerator GetEnumerator()
        {
            return new MyEnumerator(values);
        }
    }

      static void Main(string[] args)
        {
            object[] values = new object[] { 1, 2, 3 };
            MyEnumerable ir = new MyEnumerable(values);

            foreach (var item in ir)
            {
                Console.WriteLine(item);
            }
        }

言归正传,回到之前的yield return之上,看着很像我们通常写的return,但是yield return后面跟的是一个UserInfo对象,而方法的返回对象其实是一个IEnumerable对象,其实这里也可以返回一个IEnumerator,这又是为什么呢?正如我前面说的**yield return是编译器对IEnumerator和IEnumerable实现的语法糖**,其实所有这些又是编译器在幕后做了很多不为人知的“勾当”,不过这一次它做的更多。

看下用yield return实现上面的例子需要几行代码:

static IEnumerable<int> GetInts()
        {
            yield return 1;
            yield return 2;
            yield return 3;
        }

多么简洁优雅!!!yield return大大简化了我们创建迭代器的难度。通过IL DASM反汇编看下编译器都干了些什么:

01153826-7253173794724507abaa4e6b5741e317.png

可以看到编译器本质上还是生成一个类的,主要看下MoveNext方法:

01154044-409e60be0072493eb1eb7e624957657b.png

说实话,IL我基本一无所知,但大致可以看出来使用了switch(实现跳转表)和类似C语言中的goto语句(br.s),还好还有强大的reflect,逆向工程一下便可以还原“真相”:

private bool MoveNext()
{
    switch (this.<>1__state)
    {
        case 0:
            this.<>1__state = -1;
            this.<>2__current = 1;
            this.<>1__state = 1;
            return true;

        case 1:
            this.<>1__state = -1;
            this.<>2__current = 2;
            this.<>1__state = 2;
            return true;

        case 2:
            this.<>1__state = -1;
            this.<>2__current = 3;
            this.<>1__state = 3;
            return true;

        case 3:
            this.<>1__state = -1;
            break;
    }
    return false;
}

这便是编译器所做的操作,其实就是实现了一个状态机,要看完整的代码朋友们可以自己试下。这是一个再简单不过的例子貌似编译器做的并不多,那么看下文章一开始我写的那个读取文件的例子:

[CompilerGenerated]
private sealed class <Provide>d__0 : IEnumerable<UserInfo>, IEnumerable, IEnumerator<UserInfo>, IEnumerator, IDisposable
{
    // Fields
    private int <>1__state;
    private UserInfo <>2__current;
    public string <>3__parameter;
    public int <>3__position;
    public FileProvider <>4__this;
    private int <>l__initialThreadId;
    public string[] <field>5__5;
    public FileStream <fs>5__1;
    public StreamReader <reader>5__2;
    public string[] <schema>5__3;
    public UserInfo <userInfo>5__4;
    public string parameter;
    public int position;

    // Methods
    [DebuggerHidden]
    public <Provide>d__0(int <>1__state);
    private void <>m__Finally6();
    private bool MoveNext();
    [DebuggerHidden]
    IEnumerator<UserInfo> IEnumerable<UserInfo>.GetEnumerator();
    [DebuggerHidden]
    IEnumerator IEnumerable.GetEnumerator();
    [DebuggerHidden]
    void IEnumerator.Reset();
    void IDisposable.Dispose();

    // Properties
    UserInfo IEnumerator<UserInfo>.Current { [DebuggerHidden] get; }
    object IEnumerator.Current { [DebuggerHidden] get; }
}

 
Expand Methods
private bool MoveNext()
{
    bool CS$1$0000;
    try
    {
        int i;
        switch (this.<>1__state)
        {
            case 0:
                this.<>1__state = -1;
                this.<fs>5__1 = new FileStream(this.parameter, FileMode.Open);
                this.<reader>5__2 = null;
                this.<>1__state = 1;
                this.<reader>5__2 = new StreamReader(this.<fs>5__1);
                this.<schema>5__3 = this.<reader>5__2.ReadLine().Trim().Split(new char[] { ' ' });
                i = 0;
                goto Label_0095;

            case 2:
                goto Label_0138;

            default:
                goto Label_0155;
        }
    Label_0085:
        this.<reader>5__2.ReadLine();
        i++;
    Label_0095:
        if (i < this.position)
        {
            goto Label_0085;
        }
        while (!this.<reader>5__2.EndOfStream)
        {
            this.<userInfo>5__4 = new UserInfo();
            this.<userInfo>5__4.Fields = new Dictionary<string, string>();
            this.<field>5__5 = this.<reader>5__2.ReadLine().Trim().Split(new char[] { ' ' });
            for (int i = 0; i < this.<schema>5__3.Length; i++)
            {
                this.<userInfo>5__4.Fields.Add(this.<schema>5__3[i].ToLower(), this.<field>5__5[i]);
            }
            this.<>2__current = this.<userInfo>5__4;
            this.<>1__state = 2;
            return true;
        Label_0138:
            this.<>1__state = 1;
        }
        this.<>m__Finally6();
    Label_0155:
        CS$1$0000 = false;
    }
    fault
    {
        this.System.IDisposable.Dispose();
    }
    return CS$1$0000;
}

编译器以嵌套类型的形式创建了一个状态机,用来正确的记录我们在代码块中所处的位置和局部变量(包括参数)在该处的值,从上面的代码中我们看到了goto这样的语句,确实这在C#中是合法的但是平时我们基本不会用到,而且这也是不被推荐的。

一句yield return看似简单,但其实编译做了很多,而且尽善尽美,第一个例子中标红的还有一处:

finally
{
	reader.Close();
	fs.Close();
}

使用yield return这点倒和return类似,就是finally块在迭代结束后一定会执行,即使迭代是中途退出或发生异常,或者使用了yield break(这跟我们平常使用的return很像):

static IEnumerable<int> GetInts()
        {
            try
            {
                yield return 1;
                yield return 2;
                yield return 3;
            }
            finally
            {
                Console.WriteLine("do something in finally!");
            }
        }
       //main
          foreach (var item in GetInts())
            {
                Console.WriteLine(item);
                if (item==2)
                {
                    return;
                }
            }

01172753-3e6ec1d238414b1582a210e2ff033384.png

这是因为foreach保证在它包含的代码块运行结束后会执行里面所有finally块的代码。但如果我们像下面这样迭代集合话就不能保证finally块一定能执行了:

IEnumerator it = GetInts().GetEnumerator();
 it.MoveNext();
 Console.WriteLine(it.Current);
 it.MoveNext();
 Console.WriteLine(it.Current);
 it.MoveNext();
 Console.WriteLine(it.Current);

这也提醒我们在迭代集合的时候一定要用foreach,确保资源能够得到释放。 还有一点需要注意的就是yield return不能用于try…catch…块中。原因可能是编译在处理catch和yield return之间存在“冲突”,有知道的朋友可以告诉我一下,感激不尽。

yield return能暂时将控制权交给外部,我比作“程序上奇点”,让你实现穿越。能达到目的:延迟计算、异步流。

其实本文第一个代码片段已经能说明这点了,但是体现的作用只是延迟计算,yield return还有一个作用就是它能让我们写出非常优雅的异步编程代码,以前在C#中写异步流,全篇充斥这各种BeginXXX,EndXXX,虽然能达到目的但是整个流程支离破碎。这里举《C# In Depth》中的一个例子,讲的是微软并发和协调运行库CCR。

假如我们正在编写一个需要处理很多请求的服务器。作为处理这些请求的一部分,我们首先调用一个Web服务来获取身份验证令牌,接着使用这个令牌从两个独立的数据源获取数据(可以认为一个是数据库,另外一个是Web服务)。然后我们要处理这些数据,并返回结果。每一个提取数据的阶段要话费一点时间,比如1秒左右。我们可选择两种常见选项仅有同步处理和异步处理。

这个例子很具代表性,不禁让我想到了之前工作中的一个场景。我们先来看下同步版本的伪代码:

HoldingsValue ComputeTotalStockValue(string user, string password)
{
   Token token = AuthService.Check(user, password);
   Holdings stocks = DbService.GetStockHoldings(token);
   StockRates rates = StockService.GetRates(token);
   return ProcessStocks(stocks, rates);
}

同步很容易理解,但问题也很明确,如果每个请求要话费1秒钟,整个操作将话费3秒钟,并在运行时占用整个线程。在来看异步版本的:

void StartComputingTotalStockValue(string user, string password)
{
   AuthService.BeginCheck(user, password, AfterAuthCheck, null);
}
void AfterAuthCheck(IAsyncResult result)
{
   Token token = AuthService.EndCheck(result);
   IAsyncResult holdingsAsync = DbService.BeginGetStockHoldings
   (token, null, null); 
   StockService.BeginGetRates
   (token, AfterGetRates, holdingsAsync);
}
void AfterGetRates(IAsyncResult result)
{
   IAsyncResult holdingsAsync = (IAsyncResult)result.AsyncState;
   StockRates rates = StockService.EndGetRates(result);
   Holdings holdings = DbService.EndGetStockHoldings
   (holdingsAsync);
   OnRequestComplete(ProcessStocks(stocks, rates));
}

我想不需要做太多解释,但是它确实比较难理解,最起码对于初学者来说是这样的,而且更重要的一点是它是基于多线程的。最后来看下使用CCR的yield return版本:

IEnumerator<ITask> ComputeTotalStockValue(string user, string pass)
{
   Token token = null;
   yield return Ccr.ReceiveTask(
   AuthService.CcrCheck(user, pass) 
   delegate(Token t){ token = t; }
   );
   Holdings stocks = null;
   StockRates rates = null;
   yield return Ccr.MultipleReceiveTask(
   DbService.CcrGetStockHoldings(token),
   StockService.CcrGetRates(token),
   delegate(Stocks s, StockRates sr) 
   { stocks = s; rates = sr; }
   );
   OnRequestComplete(ProcessStocks(stocks, rates));
}

在了解CCR之间,这个版本可能更难理解,但是这是伪代码我们只需要理解它的思路就可以了。这个版本可以说是综合了同步和异步版本的优点,让程序员可以按照以往的思维顺序的写代码同时实现了异步流。

这里还有一个重点是,CCR在等待的时候并没有使用专用线程。其实一开始了解yield return的时候,我以为它是通过多线程实现,其实它使用的是一种更小粒度的调度单位:协程

协程和线程的区别是:协程避免了无意义的调度,由此可以提高性能,但也因此,程序员必须自己承担调度的责任,同时,协程也失去了标准线程使用多CPU的能力。

关于协程网上有很多资料,各种语言也有支持,可以说C#对协程的支持是通过yield return来体现的,而且非常优雅。其他语言中貌似也有类似的关键字,好像javascript中也有。

好吧说了这么多回到文章的标题上来,因为某些原因,现在要用Java实现文章一开头那个需求。刚刚接触Java,菜鸟一枚,本想应该也会有类似C#中yield return的语法,但是却碰壁了。找来找去就发现有一个Thread.yield(),看了api貌似并不是我想要的。好不容易在stackoverflow上找到一篇帖子:Yield Return In Java。里面提到了一个第三方库实现了类似C#中的yield return语法,下载地址

激动万分啊,可惜使用后发现貌似有点问题。这个jar包里提供一个Yielder类,按照它Wiki中的示例,只要继承这个类实现一个yieldNextCore方法就可以了,Yielder类内部有一个yieldReturn()和yieldBreak()方法,貌似就是对应C#中的yield return和yield break,于是我写下了下面的代码:

public static void main(String[] args) {
        Iterable<Integer> itr = new Yielder<Integer>() {
            @Override
            protected void yieldNextCore() {
                yieldReturn(1);
                yieldReturn(2);
                yieldReturn(3);
            }
        };

        Iterator<Integer> it = itr.iterator();
    
        while (it.hasNext()) {
            Object rdsEntity = it.next();
            System.out.println(rdsEntity);
        }
    }

但是运行结果确是一直不停的输出3,不知道我实现的有问题(Wiki里说明太少)还是因为这个库以来具体的操作系统平台,我在CentOS和Ubuntu上都试了,结果一样。不知道有没有哪位朋友知道这个jar包,很想知道原因啊。

在网上搜了很多,如我所料Java对协程肯定是支持的,只不过没有C#中yield return这样简洁的语法糖而已,我一开始的那个问题必然不是问题,只不过可能我是被C#宠坏了,才会发出“可惜Java中没有yield return”这样的感慨,还是好好学习,天天向上吧。