快捷導(dǎo)航

利用C#自定義一個(gè)時(shí)間類型YearMonth

更新時(shí)間：2023年07月26日 08:52:14 作者：天行健君子以自強(qiáng)

.Net6中加入了兩個(gè)新的時(shí)間類型：DateOnly和TimeOnly，但DateOnly和TimeOnly都有相應(yīng)的應(yīng)用場(chǎng)景，所以本文就來(lái)自定義一個(gè)時(shí)間類型YearMonth，用于解決實(shí)際項(xiàng)目開(kāi)發(fā)中的需求，希望對(duì)大家有所幫助

在.Net Framework中，我們常用的時(shí)間類型是DateTime。直到.Net6微軟加入了兩個(gè)新的時(shí)間類型：DateOnly和TimeOnly，才彌補(bǔ)了之前的不足。

DateOnly：表示僅日期。比如：某人的生日，我只關(guān)心日期，就適合用DateOnly。

TimeOnly：表示僅時(shí)間。比如：每天定時(shí)執(zhí)行某個(gè)任務(wù)，我只關(guān)心時(shí)間，就適合用TimeOnly。

由此可見(jiàn)，DateOnly和TimeOnly都有相應(yīng)的應(yīng)用場(chǎng)景。可小編在實(shí)際項(xiàng)目中遇到了這樣的業(yè)務(wù)場(chǎng)景：需要每月給客戶生成月賬單。這里我所關(guān)心的是某個(gè)月份，于是我首先想到用DateOnly表示(不考慮字符串)。

var date = new DateOnly(2023, 2, 1);    // 代表2023年2月1日

雖然DateOnly可用，但從字面理解和表現(xiàn)形式上還是略顯尷尬。 DateOnly真正表達(dá)的是某一天并不是某個(gè)月，在代碼層面也容易混淆，所以并不符合小編的心理期望。經(jīng)過(guò)一番糾結(jié)和思考，小編決定自己動(dòng)手創(chuàng)建一個(gè)表示年/月的時(shí)間類型：YearMonth。

var ym = new YearMonth(2023, 2);  // 代表2023年2月

YearMonth的源碼如下：

 /// <summary>
    /// 表示年/月的時(shí)間類型
    /// </summary>
    [JsonConverter(typeof(YearMonthJsonConverter))]
    public readonly struct YearMonth
    {
        public int Year { get; }
        public int Month { get; }
       public YearMonth(int year, int month)
       {
           Year = year;
           Month = month;
       }
      public YearMonth AddMonths(int value)
       {
         var date = new DateOnly(Year, Month, 1);
          return FromDateOnly(date.AddMonths(value));
       }
      public YearMonth AddYears(int value)
       {
           var date = new DateOnly(Year, Month, 1);
           return FromDateOnly(date.AddYears(value));
       }
      public DateOnly FirstDay()
       {
           return new DateOnly(Year, Month, 1);
       }
       public DateOnly LastDay()
       {
           var nextMonth = AddMonths(1);
           var date = new DateOnly(nextMonth.Year, nextMonth.Month, 1);
           return date.AddDays(-1);
       }
       public int DaysInMonth()
       {
           return DateTime.DaysInMonth(Year, Month);
       }
       public static YearMonth Current 
       {
           get { return FromDateTime(DateTime.Now); }
       }
       public static YearMonth UtcCurrent
       {
           get { return FromDateTime(DateTime.UtcNow); }
      }
       public static YearMonth FromDateOnly(DateOnly dateOnly)
      {
           return new YearMonth(dateOnly.Year, dateOnly.Month);
       }
       public static YearMonth FromDateTime(DateTime dateTime)
       {
           return new YearMonth(dateTime.Year, dateTime.Month);
      }
     public static YearMonth FromString(string s)
       {
           if (DateTime.TryParse(s, out var date))
           {
              return FromDateTime(date);
           }
           throw new ArgumentException("format is error", nameof(s));
      }
      public override string ToString()
      {
          return $"{Year.ToString().PadLeft(4, '0')}-{Month.ToString().PadLeft(2, '0')}";
       }
      public static bool operator ==(YearMonth left, YearMonth right)
      {
           return left.Year == right.Year && left.Month == right.Month;
       }
      public static bool operator !=(YearMonth left, YearMonth right)
      {
           return !(left.Year == right.Year && left.Month == right.Month);
       }
       public static bool operator >=(YearMonth left, YearMonth right)
      {
          return (left.Year > right.Year) || (left.Year == right.Year && left.Month >= right.Month);
       }
      public static bool operator <=(YearMonth left, YearMonth right)
      {
          return (left.Year < right.Year) || (left.Year == right.Year && left.Month <= right.Month);
      }
      public static bool operator >(YearMonth left, YearMonth right)
      {
          return (left.Year > right.Year) || (left.Year == right.Year && left.Month > right.Month);
      }
      public static bool operator <(YearMonth left, YearMonth right)
      {
          return (left.Year < right.Year) || (left.Year == right.Year && left.Month < right.Month);
      }
      public override bool Equals(object obj)
      {
          return base.Equals(obj);
      }
      public override int GetHashCode()
      {
          return base.GetHashCode();
      }       
 }

其中特性 [JsonConverter(typeof(YearMonthJsonConverter))]用于Json序列化和反序列化。

public class YearMonthJsonConverter : JsonConverter<YearMonth>
{
     public override YearMonth Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
     {
         return YearMonth.FromString(reader.GetString());
     }
     public override void Write(Utf8JsonWriter writer, YearMonth value, JsonSerializerOptions options)
     {
         writer.WriteStringValue(value.ToString());
     }
}

YearMonth的一些用法示例：

var ym = new YearMonth(2023, 2);
int n = ym.DaysInMonth();     //n：28
DateOnly d1 = ym.FirstDay();  //d1：2023/2/1
DateOnly d2 = ym.LastDay();   //d2：2023/2/28
string str = ym.ToString();   //str：2023-02
YearMonth ym2 = ym.AddMonths(1);  //ym2: 2023-03
YearMonth ym3 = YearMonth.FromDateOnly(new DateOnly(2023, 2, 8)); //ym3: 2023-02
YearMonth ym4 = YearMonth.FromDateTime(new DateTime(2023, 2, 8, 12, 23, 45)); //ym4: 2023-02
bool b = new YearMonth(2023, 3) > new YearMonth(2023, 2);  //b: true

至此，上面的YearMonth時(shí)間類型已經(jīng)滿足小編的開(kāi)發(fā)需要，當(dāng)然也可以根據(jù)需求繼續(xù)擴(kuò)展其它功能。

到此這篇關(guān)于利用C#自定義一個(gè)時(shí)間類型YearMonth的文章就介紹到這了,更多相關(guān)C#時(shí)間類型內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: