跳至内容 跳至搜索

Active Support 时间带

一个类似 Time 的类,可以表示任何时区的時間。 这是必要的,因为标准 Ruby Time 实例仅限于 UTC 和系统的 ENV['TZ'] 时区。

你永远不应该直接通过 new 创建 TimeWithZone 实例。 相反,使用 TimeZone 实例上的方法 localparseatnow,以及 TimeDateTime 实例上的 in_time_zone

Time.zone = 'Eastern Time (US & Canada)'        # => 'Eastern Time (US & Canada)'
Time.zone.local(2007, 2, 10, 15, 30, 45)        # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00
Time.zone.parse('2007-02-10 15:30:45')          # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00
Time.zone.at(1171139445)                        # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00
Time.zone.now                                   # => Sun, 18 May 2008 13:07:55.754107581 EDT -04:00
Time.utc(2007, 2, 10, 20, 30, 45).in_time_zone  # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00

有关这些方法的进一步文档,请参阅 TimeTimeZone

TimeWithZone 实例实现了与 Ruby Time 实例相同的 API,因此 TimeTimeWithZone 实例可以互换。

t = Time.zone.now                     # => Sun, 18 May 2008 13:27:25.031505668 EDT -04:00
t.hour                                # => 13
t.dst?                                # => true
t.utc_offset                          # => -14400
t.zone                                # => "EDT"
t.to_fs(:rfc822)                      # => "Sun, 18 May 2008 13:27:25 -0400"
t + 1.day                             # => Mon, 19 May 2008 13:27:25.031505668 EDT -04:00
t.beginning_of_year                   # => Tue, 01 Jan 2008 00:00:00.000000000 EST -05:00
t > Time.utc(1999)                    # => true
t.is_a?(Time)                         # => true
t.is_a?(ActiveSupport::TimeWithZone)  # => true
方法
#
A
B
C
D
E
F
G
H
I
K
L
M
N
P
R
S
T
U
X
Y
Z

常量

PRECISIONS = Hash.new { |h, n| h[n] = "%FT%T.%#{n}N" }
 
SECONDS_PER_DAY = 86400
 

属性

[R] time_zone

类公共方法

new(utc_time, time_zone, local_time = nil, period = nil)

# File activesupport/lib/active_support/time_with_zone.rb, line 51
def initialize(utc_time, time_zone, local_time = nil, period = nil)
  @utc = utc_time ? transfer_time_values_to_utc_constructor(utc_time) : nil
  @time_zone, @time = time_zone, local_time
  @period = @utc ? period : get_period_and_ensure_valid_local_time(period)
end

实例公共方法

+(other)

将一段時間添加到当前对象的当前时间,并返回该值作为新的 TimeWithZone 对象。

Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Sun, 02 Nov 2014 01:26:28.725182881 EDT -04:00
now + 1000          # => Sun, 02 Nov 2014 01:43:08.725182881 EDT -04:00

如果我们正在添加一个可变长度的 Duration(即,年、月、日),则从 time 向前移动,否则从 utc 向前移动,以提高在跨越 DST 边界时的精度。

例如,时间 + 24.hours 将精确前进 24 小时,而时间 + 1.day 将前进 23-25 小时,具体取决于日期。

now + 24.hours      # => Mon, 03 Nov 2014 00:26:28.725182881 EST -05:00
now + 1.day         # => Mon, 03 Nov 2014 01:26:28.725182881 EST -05:00
也称为:sincein
# File activesupport/lib/active_support/time_with_zone.rb, line 298
def +(other)
  if duration_of_variable_length?(other)
    method_missing(:+, other)
  else
    begin
      result = utc + other
    rescue TypeError
      result = utc.to_datetime.since(other)
      ActiveSupport.deprecator.warn(
        "Adding an instance of #{other.class} to an instance of #{self.class} is deprecated. This behavior will raise " \
        "a `TypeError` in Rails 8.1."
      )
      result.in_time_zone(time_zone)
    end
    result.in_time_zone(time_zone)
  end
end

-(other)

减去一段時間并返回一个新的 TimeWithZone 对象,除非另一个值 acts_like? 时间。 在这种情况下,它将减去另一个时间并返回以秒为单位的差值,作为 Float

Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Mon, 03 Nov 2014 00:26:28.725182881 EST -05:00
now - 1000          # => Mon, 03 Nov 2014 00:09:48.725182881 EST -05:00

如果减去一个可变长度的 Duration(即,年、月、日),则从 time 向后移动,否则从 utc 向后移动,以提高在跨越 DST 边界时的精度。

例如,时间 - 24.hours 将减去正好 24 小时,而时间 - 1.day 将减去 23-25 小时,具体取决于日期。

now - 24.hours      # => Sun, 02 Nov 2014 01:26:28.725182881 EDT -04:00
now - 1.day         # => Sun, 02 Nov 2014 00:26:28.725182881 EDT -04:00

如果 TimeWithZone 对象和另一个值都像 Time 一样,则将返回 Float

Time.zone.now - 1.day.ago # => 86399.999967
# File activesupport/lib/active_support/time_with_zone.rb, line 341
def -(other)
  if other.acts_like?(:time)
    getutc - other.getutc
  elsif duration_of_variable_length?(other)
    method_missing(:-, other)
  else
    result = utc - other
    result.in_time_zone(time_zone)
  end
end

<=>(other)

在比较时使用 UTC 中的时间。

# File activesupport/lib/active_support/time_with_zone.rb, line 231
def <=>(other)
  utc <=> other
end

acts_like_time?()

以便 self acts_like?(:time)

# File activesupport/lib/active_support/time_with_zone.rb, line 504
def acts_like_time?
  true
end

advance(options)

使用 Date 为年、月和日提供精确的 Time 计算,根据儒略历。 结果以新的 TimeWithZone 对象返回。

options 参数采用一个包含以下任何键的哈希::years:months:weeks:days:hours:minutes:seconds

如果按可变长度的值(即,年、周、月、日)递增,则从 time 向前移动,否则从 utc 向前移动,以提高在跨越 DST 边界时的精度。

Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Sun, 02 Nov 2014 01:26:28.558049687 EDT -04:00
now.advance(seconds: 1) # => Sun, 02 Nov 2014 01:26:29.558049687 EDT -04:00
now.advance(minutes: 1) # => Sun, 02 Nov 2014 01:27:28.558049687 EDT -04:00
now.advance(hours: 1)   # => Sun, 02 Nov 2014 01:26:28.558049687 EST -05:00
now.advance(days: 1)    # => Mon, 03 Nov 2014 01:26:28.558049687 EST -05:00
now.advance(weeks: 1)   # => Sun, 09 Nov 2014 01:26:28.558049687 EST -05:00
now.advance(months: 1)  # => Tue, 02 Dec 2014 01:26:28.558049687 EST -05:00
now.advance(years: 1)   # => Mon, 02 Nov 2015 01:26:28.558049687 EST -05:00
# File activesupport/lib/active_support/time_with_zone.rb, line 430
def advance(options)
  # If we're advancing a value of variable length (i.e., years, weeks, months, days), advance from #time,
  # otherwise advance from #utc, for accuracy when moving across DST boundaries
  if options.values_at(:years, :weeks, :months, :days).any?
    method_missing(:advance, options)
  else
    utc.advance(options).in_time_zone(time_zone)
  end
end

ago(other)

从当前对象的当前时间减去一段時間,并将结果作为新的 TimeWithZone 对象返回。

Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Mon, 03 Nov 2014 00:26:28.725182881 EST -05:00
now.ago(1000)       # => Mon, 03 Nov 2014 00:09:48.725182881 EST -05:00

如果我们正在减去一个可变长度的 Duration(即,年、月、日),则从 time 向后移动,否则从 utc 向后移动,以提高在跨越 DST 边界时的精度。

例如,time.ago(24.hours) 将向后移动正好 24 小时,而 time.ago(1.day) 将向后移动 23-25 小时,具体取决于日期。

now.ago(24.hours)   # => Sun, 02 Nov 2014 01:26:28.725182881 EDT -04:00
now.ago(1.day)      # => Sun, 02 Nov 2014 00:26:28.725182881 EDT -04:00
# File activesupport/lib/active_support/time_with_zone.rb, line 369
def ago(other)
  since(-other)
end

as_json(options = nil)

将时间强制转换为字符串以进行 JSON 编码。 默认格式为 ISO 8601。 通过将 ActiveSupport::JSON::Encoding.use_standard_json_time_format 设置为 false,可以获得 %Y/%m/%d %H:%M:%S +offset 样式。

# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = true
Time.utc(2005,2,1,15,15,10).in_time_zone("Hawaii").as_json
# => "2005-02-01T05:15:10.000-10:00"

# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = false
Time.utc(2005,2,1,15,15,10).in_time_zone("Hawaii").as_json
# => "2005/02/01 05:15:10 -1000"
# File activesupport/lib/active_support/time_with_zone.rb, line 166
def as_json(options = nil)
  if ActiveSupport::JSON::Encoding.use_standard_json_time_format
    xmlschema(ActiveSupport::JSON::Encoding.time_precision)
  else
    %(#{time.strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)})
  end
end

between?(min, max)

如果当前对象的当前时间位于指定的 minmax 时间内,则返回 true。

# File activesupport/lib/active_support/time_with_zone.rb, line 239
def between?(min, max)
  utc.between?(min, max)
end

blank?()

ActiveSupport::TimeWithZone 的实例永远不会为空

# File activesupport/lib/active_support/time_with_zone.rb, line 515
def blank?
  false
end

change(options)

返回一个新的 ActiveSupport::TimeWithZone,其中一个或多个元素已根据 options 参数更改。 时间选项 (:hour:min:sec:usec:nsec) 级联重置,因此如果仅传递小时,则分钟、秒、微秒和纳秒将设置为 0。 如果传递小时和分钟,则秒、微秒和纳秒将设置为 0。options 参数采用一个包含以下任何键的哈希::year:month:day:hour:min:sec:usec:nsec:offset:zone。 传递 :usec:nsec,而不是两者都传递。 同样,传递 :zone:offset,而不是两者都传递。

t = Time.zone.now          # => Fri, 14 Apr 2017 11:45:15.116992711 EST -05:00
t.change(year: 2020)       # => Tue, 14 Apr 2020 11:45:15.116992711 EST -05:00
t.change(hour: 12)         # => Fri, 14 Apr 2017 12:00:00.000000000 EST -05:00
t.change(min: 30)          # => Fri, 14 Apr 2017 11:30:00.000000000 EST -05:00
t.change(offset: "-10:00") # => Fri, 14 Apr 2017 11:45:15.116992711 HST -10:00
t.change(zone: "Hawaii")   # => Fri, 14 Apr 2017 11:45:15.116992711 HST -10:00
# File activesupport/lib/active_support/time_with_zone.rb, line 390
def change(options)
  if options[:zone] && options[:offset]
    raise ArgumentError, "Can't change both :offset and :zone at the same time: #{options.inspect}"
  end

  new_time = time.change(options)

  if options[:zone]
    new_zone = ::Time.find_zone(options[:zone])
  elsif options[:offset]
    new_zone = ::Time.find_zone(new_time.utc_offset)
  end

  new_zone ||= time_zone
  periods = new_zone.periods_for_local(new_time)

  self.class.new(nil, new_zone, new_time, periods.include?(period) ? period : nil)
end

comparable_time()

utc 的别名

dst?()

如果当前时间在指定时区的夏令时内,则返回 true。

Time.zone = 'Eastern Time (US & Canada)'    # => 'Eastern Time (US & Canada)'
Time.zone.parse("2012-5-30").dst?           # => true
Time.zone.parse("2012-11-30").dst?          # => false
也称为:isdst
# File activesupport/lib/active_support/time_with_zone.rb, line 94
def dst?
  period.dst?
end

eql?(other)

如果 other 等于当前对象,则返回 true

# File activesupport/lib/active_support/time_with_zone.rb, line 274
def eql?(other)
  other.eql?(utc)
end

formatted_offset(colon = true, alternate_utc_string = nil)

返回一个格式化的字符串,表示与 UTC 的偏移量,或者如果时区已经是 UTC 则返回一个备用字符串。

Time.zone = 'Eastern Time (US & Canada)'   # => "Eastern Time (US & Canada)"
Time.zone.now.formatted_offset(true)       # => "-05:00"
Time.zone.now.formatted_offset(false)      # => "-0500"
Time.zone = 'UTC'                          # => "UTC"
Time.zone.now.formatted_offset(true, "0")  # => "0"
# File activesupport/lib/active_support/time_with_zone.rb, line 125
def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon)
end

freeze()

# File activesupport/lib/active_support/time_with_zone.rb, line 523
def freeze
  # preload instance variables before freezing
  period; utc; time; to_datetime; to_time
  super
end

future?()

如果当前对象的日期时间在未来,则返回 true。

# File activesupport/lib/active_support/time_with_zone.rb, line 269
def future?
  utc.future?
end

getgm()

utc 的别名

getlocal(utc_offset = nil)

别名:localtime

getutc()

utc 的别名

gmt?()

别名:utc?

gmt_offset()

别名:utc_offset

gmtime()

utc 的别名

gmtoff()

别名:utc_offset

hash()

# File activesupport/lib/active_support/time_with_zone.rb, line 278
def hash
  utc.hash
end

httpdate()

返回对象的日期和时间字符串,格式为 HTTP 请求所使用。

Time.zone.now.httpdate  # => "Tue, 01 Jan 2013 04:39:43 GMT"
# File activesupport/lib/active_support/time_with_zone.rb, line 186
def httpdate
  utc.httpdate
end

in(other)

别名:+

in_time_zone(new_zone = ::Time.zone)

返回Time.zone或指定时区的同步时间。

# File activesupport/lib/active_support/time_with_zone.rb, line 77
def in_time_zone(new_zone = ::Time.zone)
  return self if time_zone == new_zone
  utc.in_time_zone(new_zone)
end

inspect()

返回对象的日期、时间、时区和与 UTC 的偏移量的字符串。

Time.zone.now.inspect # => "Thu, 04 Dec 2014 11:00:25.624541392 EST -05:00"
# File activesupport/lib/active_support/time_with_zone.rb, line 140
def inspect
  "#{time.strftime('%F %H:%M:%S.%9N')} #{zone} #{formatted_offset}"
end

is_a?(klass)

假设我们是Time,以阻止类型检查。

也称为:kind_of?
# File activesupport/lib/active_support/time_with_zone.rb, line 509
def is_a?(klass)
  klass == ::Time || super
end

isdst()

别名:dst?

iso8601(fraction_digits = 0)

别名:xmlschema

kind_of?(klass)

别名:is_a?

localtime(utc_offset = nil)

返回系统时区的同步时间的Time实例。

也称为:getlocal
# File activesupport/lib/active_support/time_with_zone.rb, line 83
def localtime(utc_offset = nil)
  utc.getlocal(utc_offset)
end

marshal_dump()

# File activesupport/lib/active_support/time_with_zone.rb, line 529
def marshal_dump
  [utc, time_zone.name, time]
end

marshal_load(variables)

# File activesupport/lib/active_support/time_with_zone.rb, line 533
def marshal_load(variables)
  initialize(variables[0].utc, ::Time.find_zone(variables[1]), variables[2].utc)
end

method_missing(...)

将缺失的方法发送到time实例,并用现有time_zone将结果包装到新的TimeWithZone中。

# File activesupport/lib/active_support/time_with_zone.rb, line 553
def method_missing(...)
  wrap_with_time_zone time.__send__(...)
rescue NoMethodError => e
  raise e, e.message.sub(time.inspect, inspect).sub("Time", "ActiveSupport::TimeWithZone"), e.backtrace
end

next_day?()

别名:tomorrow?

past?()

如果当前对象的日期时间在过去,则返回 true。

# File activesupport/lib/active_support/time_with_zone.rb, line 244
def past?
  utc.past?
end

period()

返回底层的TZInfo::TimezonePeriod

# File activesupport/lib/active_support/time_with_zone.rb, line 72
def period
  @period ||= time_zone.period_for_utc(@utc)
end

prev_day?()

别名:yesterday?

respond_to?(sym, include_priv = false)

在某些情况下,例如当使用 Kernel#String 执行类型转换时,不会调用 respond_to_missing?

# File activesupport/lib/active_support/time_with_zone.rb, line 539
def respond_to?(sym, include_priv = false)
  # ensure that we're not going to throw and rescue from NoMethodError in method_missing which is slow
  return false if sym.to_sym == :to_str
  super
end

respond_to_missing?(sym, include_priv)

确保代理类响应底层时间实例响应的所有方法。

# File activesupport/lib/active_support/time_with_zone.rb, line 547
def respond_to_missing?(sym, include_priv)
  time.respond_to?(sym, include_priv)
end

rfc2822()

返回对象的日期和时间字符串,格式为 RFC 2822 标准格式。

Time.zone.now.rfc2822  # => "Tue, 01 Jan 2013 04:51:39 +0000"
也称为:rfc822
# File activesupport/lib/active_support/time_with_zone.rb, line 194
def rfc2822
  to_fs(:rfc822)
end

rfc3339(fraction_digits = 0)

别名:xmlschema

rfc822()

别名:rfc2822

since(other)

别名:+

strftime(format)

在传递给 Time#strftime 之前用 +zone 替换%Z指令,以便时区信息正确。

# File activesupport/lib/active_support/time_with_zone.rb, line 225
def strftime(format)
  format = format.gsub(/((?:\A|[^%])(?:%%)*)%Z/, "\\1#{zone}")
  getlocal(utc_offset).strftime(format)
end

time()

返回Time实例,该实例表示time_zone中的时间。

# File activesupport/lib/active_support/time_with_zone.rb, line 58
def time
  @time ||= incorporate_utc_offset(@utc, utc_offset)
end

to_a()

返回Array,其中包含Time的各个部分,按顺序排列:[秒、分钟、小时、日、月、年、星期几、年中的日期、夏令时?、时区]。

now = Time.zone.now     # => Tue, 18 Aug 2015 02:29:27.485278555 UTC +00:00
now.to_a                # => [27, 29, 2, 18, 8, 2015, 2, 230, false, "UTC"]
# File activesupport/lib/active_support/time_with_zone.rb, line 453
def to_a
  [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone]
end

to_datetime()

返回带有时区 UTC 偏移量的DateTime实例。

Time.zone.now.to_datetime                         # => Tue, 18 Aug 2015 02:32:20 +0000
Time.current.in_time_zone('Hawaii').to_datetime   # => Mon, 17 Aug 2015 16:32:20 -1000
# File activesupport/lib/active_support/time_with_zone.rb, line 486
def to_datetime
  @to_datetime ||= utc.to_datetime.new_offset(Rational(utc_offset, 86_400))
end

to_f()

返回对象的时间作为自纪元(1970 年 1 月 1 日 00:00 UTC)以来的秒数的浮点数。

Time.zone.now.to_f # => 1417709320.285418
# File activesupport/lib/active_support/time_with_zone.rb, line 461
def to_f
  utc.to_f
end

to_formatted_s(format = :default)

别名:to_fs

to_fs(format = :default)

返回对象的时间字符串。

此方法的别名为 to_formatted_s

接受可选的 format

  • :default - 默认值,模仿 Ruby Time#to_s 格式。

  • :db - 格式将时间输出为 UTC :db 时间。请参阅 Time#to_fs(:db)。

  • 可以使用 Time::DATE_FORMATS 中的任何键。请参阅 active_support/core_ext/time/conversions.rb。

也称为:to_formatted_s
# File activesupport/lib/active_support/time_with_zone.rb, line 212
def to_fs(format = :default)
  if format == :db
    utc.to_fs(format)
  elsif formatter = ::Time::DATE_FORMATS[format]
    formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
  else
    to_s
  end
end

to_i()

返回对象的时间作为自纪元(1970 年 1 月 1 日 00:00 UTC)以来的秒数的整数。

Time.zone.now.to_i # => 1417709320
也称为:tv_sec
# File activesupport/lib/active_support/time_with_zone.rb, line 469
def to_i
  utc.to_i
end

to_r()

返回对象的时间作为自纪元(1970 年 1 月 1 日 00:00 UTC)以来的秒数的有理数。

Time.zone.now.to_r # => (708854548642709/500000)
# File activesupport/lib/active_support/time_with_zone.rb, line 478
def to_r
  utc.to_r
end

to_s()

返回对象的时间字符串。

# File activesupport/lib/active_support/time_with_zone.rb, line 200
def to_s
  "#{time.strftime("%Y-%m-%d %H:%M:%S")} #{formatted_offset(false, 'UTC')}" # mimicking Ruby Time#to_s format
end

to_time()

返回一个 Time 实例,它可以与 self 具有相同的时区,与 self 具有相同的 UTC 偏移量,或者根据 ActiveSupport.to_time_preserves_timezone 的设置在本地系统时区内。

# File activesupport/lib/active_support/time_with_zone.rb, line 493
def to_time
  if preserve_timezone == :zone
    @to_time_with_timezone ||= getlocal(time_zone)
  elsif preserve_timezone
    @to_time_with_instance_offset ||= getlocal(utc_offset)
  else
    @to_time_with_system_offset ||= getlocal
  end
end

today?()

如果当前对象的时间落在当前日期内,则返回 true。

# File activesupport/lib/active_support/time_with_zone.rb, line 250
def today?
  time.today?
end

tomorrow?()

如果当前对象的时间落在下一天(明天)内,则返回 true。

也称为:next_day?
# File activesupport/lib/active_support/time_with_zone.rb, line 256
def tomorrow?
  time.tomorrow?
end

tv_sec()

别名:to_i

utc()

返回 UTC 时区中同时时间的 Time 实例。

# File activesupport/lib/active_support/time_with_zone.rb, line 63
def utc
  @utc ||= incorporate_utc_offset(@time, -utc_offset)
end

utc?()

如果当前时区设置为 UTC,则返回 true。

Time.zone = 'UTC'                           # => 'UTC'
Time.zone.now.utc?                          # => true
Time.zone = 'Eastern Time (US & Canada)'    # => 'Eastern Time (US & Canada)'
Time.zone.now.utc?                          # => false
也称为:gmt?
# File activesupport/lib/active_support/time_with_zone.rb, line 105
def utc?
  zone == "UTC" || zone == "UCT"
end

utc_offset()

返回当前时间到 UTC 时间的偏移量(以秒为单位)。

也称为:gmt_offset, gmtoff
# File activesupport/lib/active_support/time_with_zone.rb, line 111
def utc_offset
  period.observed_utc_offset
end

xmlschema(fraction_digits = 0)

返回对象的时间字符串,以 ISO 8601 标准格式表示。

Time.zone.now.xmlschema  # => "2014-12-04T11:02:37-05:00"
也称为:iso8601, rfc3339
# File activesupport/lib/active_support/time_with_zone.rb, line 148
def xmlschema(fraction_digits = 0)
  "#{time.strftime(PRECISIONS[fraction_digits.to_i])}#{formatted_offset(true, 'Z')}"
end

yesterday?()

如果当前对象的时间落在前一天(昨天)内,则返回 true。

也称为:prev_day?
# File activesupport/lib/active_support/time_with_zone.rb, line 263
def yesterday?
  time.yesterday?
end

zone()

返回时区缩写。

Time.zone = 'Eastern Time (US & Canada)'   # => "Eastern Time (US & Canada)"
Time.zone.now.zone # => "EST"
# File activesupport/lib/active_support/time_with_zone.rb, line 133
def zone
  period.abbreviation
end