人们常说“细节决定成败”。
编码工作中,同样需要关注细节。
本文将给出3个小实例来说明编码中关注细节的重要性,同时给出作者对如何注意编码细节的一点见解(说的不对,请指正)。
例1 这个问题如此地显而易见,竟然没有被发现。
- List<int> numList = new List<int>();
- numList.Add(3);
- numList.Add(1);
- numList.Add(4);
- numList.Add(2);
- numList.Add(5);
- numList.OrderBy(it => it).ToList();
- foreach (int i in numList)
- {
- Console.WriteLine(i);
- }
例2 当时要是考虑得再多一点,问题也就不会出现了。
- using System;
- using System.Collections.Generic;
- using System.Linq;
- using System.Text;
- namespace NoticeDetailExp4
- {
- class Program
- {
- static void Main(string[] args)
- {
- //这里的left、top、width、height被写死了,实际情形中是通过某种计算产生的
- double width = 1.5;
- double height = 1.5;
- double left = 0;
- double top = 0;
- if (width != 0 && height != 0)
- {
- Rectangle r = ExampleMethod(left, top, width, height);
- }
- }
- public static Rectangle ExampleMethod(double left, double top, double width, double height)
- {
- return new Rectangle(left, top, width, height);
- }
- }
- public class Rectangle
- {
- private double left;
- public double top;
- public double width;
- public double height;
- public Rectangle(double left, double top, double width, double height)
- {
- if (width <= 0 || height <= 0)
- {
- throw new InvalidOperationException();
- }
- this.left = left;
- this.top = top;
- this.width = width;
- this.height = height;
- }
- }
- }
本例中定义了矩形类Rectangle,Rectangle类的构造函数接收四个参数left,top,width,height来生成Rectangle对象,在生成Rectangle对象时会对输入参数width、height进行校验,当二者中有一个小于等于0时便会抛出无效操作的异常(矩形的长度和高度必须大于0)。再看Rectangle类的实例化代码,调用Rectangle类的构造函数进行实例化前,先对width和height的值进行校验,当width与height的值都不等于0时就调用Rectangle类的实例化方法。这样一来,问题就来了,Rectangle构造函数中要求的width与height的值必须大于0,而在类的实例化前,我们判断width、height值是否合法的条件却是width、height值不等于0,这样一来当我们传入负值时便同样会导致无效操作的异常。当时编码者在实例化Rectangle类时可谓是信心满满地认为width、height值是不会小于0 的,但是不幸的事还是发生了,在某种极端条件下这里的width、height的值小于0了,自然而然出现了BUG。这个例子说明:有些时候我们过于相信自己的判断其实也是忽略细节的另一种表现,要想编码工作尽量趋于完美,我们就应该尽量想得远一点,对于某种解决方案只要有更保险的解决办法时,我们还是应该采用更保险的解决方案。
例3 找个最好的实现方案,感觉真的很美好
- using System;
- using System.Collections.Generic;
- using System.Linq;
- namespace NoticeDetailExp2
- {
- class Program
- {
- static void Main(string[] args)
- {
- List<Work> WorkList = new List<Work>();
- WorkList.Add(new Work() { Name = "Work1", StartDate = new DateTime(2013, 12, 7), EndDate = new DateTime(2013, 12, 9) });
- WorkList.Add(new Work() { Name = "Work2", StartDate = new DateTime(2013, 12, 4), EndDate = new DateTime(2013, 12, 7) });
- WorkList.Add(new Work() { Name = "Work3", StartDate = new DateTime(2013, 12, 7), EndDate = new DateTime(2013, 12, 14) });
- WorkList.Add(new Work() { Name = "Work4", StartDate = new DateTime(2013, 12, 5), EndDate = new DateTime(2013, 12, 14) });
- WorkList.Add(new Work() { Name = "Work5", StartDate = new DateTime(2013, 12, 4), EndDate = new DateTime(2013, 12, 5) });
- WorkList.Add(new Work() { Name = "Work6", StartDate = new DateTime(2013, 12, 13), EndDate = new DateTime(2013, 12, 14) });
- DateTime dt1 = new DateTime(2013, 12, 6);
- DateTime dt2 = new DateTime(2013, 12, 12);
- var needList = WorkList.Where(it => !(it.StartDate > dt2 || it.EndDate < dt1));
- foreach (var work in needList)
- {
- Console.WriteLine(work.Name + "," + work.StartDate + "," + work.EndDate);
- }
- }
- public class Work
- {
- public string Name { get; set; }
- public DateTime StartDate { get; set; }
- public DateTime EndDate { get; set; }
- }
- }
- }
实例3主要是想实现:筛选出WorkList中满足条件的作业。条件是:作业时间与给定的时间区间[dt1,dt2]存在交集(具体见下图所示)。
图中的红色线条代表给定的时间区间[dt1,dt2],(1)-(6)代表所有类型的作业(按照时间跨度区分的作业),很显然图中的(1)、(2)、(3)、(4)的作业满足条件应该被筛选出,而剩下的(5)、(6)应该被排除在外。那这个筛选条件用代码该怎样实现呢,至少有两种实现方法。
方案1:
- var needList = WorkList.Where(it =>
- (it.StartDate < dt1 && it.EndDate > dt1) //(1)
- || (it.StartDate > dt1 && it.EndDate < dt2) //(2)
- || (it.StartDate > dt1 && it.EndDate > dt2) //(3)
- || (it.StartDate < dt1 && it.EndDate > dt2));//(4)
方案2:
- var needList = WorkList.Where(it => !(it.StartDate > dt2 || it.EndDate < dt1));
本例中采用方案2,方案2是先找到(5)、(6)类作业,再将(5)、(6)类作业从集合中排除。而方案1则是直接从集合中找出(1)、(2)、(3)、(4)类作业。采用方案1写出的条件表达式较复杂,稍不注意便会出错,而采用方案2的代码简单而同样不难理解,综合考虑,选择了方案2。例3主要是想告诉大家:其实每个问题往往都有很多种解决方案,选择一个最好的方案,同样是注意细节的一种表现。
好了,本文列举了3个实例说明了编码过程中注意细节的重要性,并得出了自己的一点看法:关注细节,首先不要犯一些低级错误,其次就是要尽量考虑远一点(预知风险),最后就是能够选择最优的解决方案。