如何传递datetime参数?

时间:2013-01-16 13:28:14

标签: asp.net datetime asp.net-web-api

如何将UTC日期传递给Web API?

传递2010-01-01工作正常,但是当我传递2014-12-31T22:00:00.000Z的UTC日期(带有时间组件)时,我得到HTTP 404响应。所以

http://domain/api/controller/action/2012-12-31T22:00:00.000Z

产生404错误响应,而

http://domain/api/controller/action/2012-12-31

工作正常。

如何将UTC日期传递给Web API - 或者至少指定日期时间?

10 个答案:

答案 0 :(得分:24)

问题是双重的:

1。路径中的.

默认情况下,IIS将所有URI中的点作为静态资源处理,尝试返回它并完全跳过进一步处理(通过Web API)。这在[{1}}部分的Web.config中配置:默认处理程序处理system.webServer.handlers。你不会找到很多关于这个path="*."属性中的奇怪语法的文档(正则表达式会更有意义),但这显然意味着“任何不包含点的东西”(以及任何来自点的字符) 2下方)。因此名为path的'无扩展'。

在我看来,按照“正确性”的顺序,可能有多种解决方案:

  • 专门为必须允许点的路由添加新的处理程序。请务必在之前添加默认值。为此,请确保先删除默认处理程序,然后将其添加回来。
  • ExtensionlessUrlHandler-Integrated-4.0属性更改为path="*."。然后它会抓住一切。请注意,从那时起,您的web api将不再将带点的来电解释为静态资源!如果您在Web api上托管静态资源,则不建议这样做!
  • 将以下内容添加到您的Web.config中,以无条件处理所有请求:path="*"下:<system.webserver>

2。路径中的<modules runAllManagedModulesForAllRequests="true">

更改上述内容后,默认情况下会出现以下错误:

  

从客户端(:)检测到潜在危险的Request.Path值。

您可以在Web.config中更改预定义的不允许/无效字符。在:下,添加以下内容:<system.web>。我已从标准无效字符列表中删除了<httpRuntime requestPathInvalidCharacters="&lt;,&gt;,%,&amp;,*,\,?" />

更简单/更安全的解决方案

虽然不是您问题的答案,但更安全,更简单的解决方案是更改请求,以便不需要所有这些。这可以通过两种方式完成:

  1. 将日期作为查询字符串参数传递,例如:
  2. 从每个请求中删除?date=2012-12-31T22:00:00.000Z。你仍然需要允许.000(cfr第2点)。

答案 1 :(得分:15)

我感觉到你的痛苦......还有另一种日期时间格式......正是你所需要的!

使用Web Api 2可以使用路由属性来指定参数。

因此,使用您的类和方法上的属性,您可以使用此utc格式编写REST URL,但是您遇到了麻烦(显然是ISO8601,可能是使用startDate.toISOString())

[Route(@"daterange/{startDate:regex(^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$)}/{endDate:regex(^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$)}")]
    [HttpGet]
    public IEnumerable<MyRecordType> GetByDateRange(DateTime startDate, DateTime endDate)

....但是,虽然这适用于一个日期(startDate),但由于某种原因,当endDate采用这种格式时它不起作用...调试了几个小时,只有线索是异常说它不喜欢冒号“: “(即使web.config设置为:

<system.web>
    <compilation debug="true" targetFramework="4.5.1" />
    <httpRuntime targetFramework="4.5.1" requestPathInvalidCharacters="" />
</system.web>

因此,让我们制作另一种日期格式(取自ISO日期格式的polyfill)并将其添加到Javascript日期(为简洁起见,最多只转换为几分钟):

if (!Date.prototype.toUTCDateTimeDigits) {
    (function () {

        function pad(number) {
            if (number < 10) {
                return '0' + number;
            }
            return number;
        }

        Date.prototype.toUTCDateTimeDigits = function () {
            return this.getUTCFullYear() +
              pad(this.getUTCMonth() + 1) +
              pad(this.getUTCDate()) +
              'T' +
              pad(this.getUTCHours()) +
              pad(this.getUTCMinutes()) +
              'Z';
        };

    }());
}

然后,当您将日期发送到Web API 2方法时,您可以将它们从字符串转换为日期:

[RoutePrefix("api/myrecordtype")]
public class MyRecordTypeController : ApiController
{


    [Route(@"daterange/{startDateString}/{endDateString}")]
    [HttpGet]
    public IEnumerable<MyRecordType> GetByDateRange([FromUri]string startDateString, [FromUri]string endDateString)
    {
        var startDate = BuildDateTimeFromYAFormat(startDateString);
        var endDate = BuildDateTimeFromYAFormat(endDateString);
    ...
    }

    /// <summary>
    /// Convert a UTC Date String of format yyyyMMddThhmmZ into a Local Date
    /// </summary>
    /// <param name="dateString"></param>
    /// <returns></returns>
    private DateTime BuildDateTimeFromYAFormat(string dateString)
    {
        Regex r = new Regex(@"^\d{4}\d{2}\d{2}T\d{2}\d{2}Z$");
        if (!r.IsMatch(dateString))
        {
            throw new FormatException(
                string.Format("{0} is not the correct format. Should be yyyyMMddThhmmZ", dateString)); 
        }

        DateTime dt = DateTime.ParseExact(dateString, "yyyyMMddThhmmZ", CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal);

        return dt;
    }

所以网址是

http://domain/api/myrecordtype/daterange/20140302T0003Z/20140302T1603Z

Hanselman在此提供了一些相关信息:

http://www.hanselman.com/blog/OnTheNightmareThatIsJSONDatesPlusJSONNETAndASPNETWebAPI.aspx

答案 2 :(得分:13)

产品Web API控制器中的

[RoutePrefix("api/product")]
public class ProductController : ApiController
{
    private readonly IProductRepository _repository;
    public ProductController(IProductRepository repository)
    {
        this._repository = repository;
    }

    [HttpGet, Route("orders")]
    public async Task<IHttpActionResult> GetProductPeriodOrders(string productCode, DateTime dateStart, DateTime dateEnd)
    {
        try
        {
            IList<Order> orders = await _repository.GetPeriodOrdersAsync(productCode, dateStart.ToUniversalTime(), dateEnd.ToUniversalTime());
            return Ok(orders);
        }
        catch(Exception ex)
        {
            return NotFound();
        }
    }
}

在Fiddler中测试GetProductPeriodOrders方法 - 作曲家:

http://localhost:46017/api/product/orders?productCode=100&dateStart=2016-12-01T00:00:00&dateEnd=2016-12-31T23:59:59

DateTime格式:

yyyy-MM-ddTHH:mm:ss

javascript传递参数使用moment.js

const dateStart = moment(startDate).format('YYYY-MM-DDTHH:mm:ss');
const dateEnd = moment(endDate).format('YYYY-MM-DDTHH:mm:ss');

答案 3 :(得分:6)

这是可行解决方案的解决方案和模型。在客户端使用Moment.js格式化日期,转换为unix时间。

 $scope.startDate.unix()

将路线参数设置得很长。

[Route("{startDate:long?}")]
public async Task<object[]> Get(long? startDate)
{
    DateTime? sDate = new DateTime();

        if (startDate != null)
        {
            sDate = new DateTime().FromUnixTime(startDate.Value); 
        }
        else
        {
            sDate = null;
        }
         ... your code here!
  }

为Unix时间创建扩展方法。 Unix DateTime Method

答案 4 :(得分:3)

事实上,将参数明确指定为“date ='fulldatetime'就像魅力一样。所以现在这将是一个解决方案:不要使用逗号,而是使用旧的GET方法。

答案 5 :(得分:1)

以前这是一项痛苦的任务,但现在我们可以使用toUTCString():

示例:

[HttpPost]
public ActionResult Query(DateTime Start, DateTime End)

将以下内容放入Ajax发布请求

data: {
    Start: new Date().toUTCString(),
    End: new Date().toUTCString()
},

答案 6 :(得分:0)

作为s k答案的类似替代方法,我可以在查询字符串中传递以Date.prototype.toISOString()格式设置的日期。这是标准的ISO 8601格式,.Net Web API控制器接受该格式,而无需对路由或操作进行任何其他配置。

例如

var dateString = dateObject.toISOString(); // "2019-07-01T04:00:00.000Z"

答案 7 :(得分:0)

由于我已经编码了ISO-8859-1操作系统,因此无法识别日期格式“ dd.MM.yyyy HH:mm:sss”是使用InvariantCulture字符串的有效方法。

hero_qs = Hero.objects.filter(category=OuterRef("pk"))
.order_by("-benevolence_factor")

Category.objects.all()
.annotate(most_benevolent_hero=Subquery(hero_qs.values('name')[:1]))

答案 8 :(得分:0)

通过查看您的代码,我假设您对DateTime对象的“时间”没有任何担心。如果是这样,则可以将日期,月份和年份作为整数参数传递。请参见以下代码。这是我当前项目中的一个可行示例。

优点是;这种方法可以帮助我避免DateTime格式问题和区域性不兼容。

    /// <summary>
    /// Get Arrivals Report Seven Day Forecast
    /// </summary>
    /// <param name="day"></param>
    /// <param name="month"></param>
    /// <param name="year"></param>
    /// <returns></returns>
    [HttpGet("arrivalreportsevendayforecast/{day:int}/{month:int}/{year:int}")]
    public async Task<ActionResult<List<ArrivalsReportSevenDayForecastModel>>> GetArrivalsReportSevenDayForecast(int day, int month, int year)
    {
        DateTime selectedDate = new DateTime(year, month, day);
        IList<ArrivalsReportSevenDayForecastModel> arrivingStudents = await _applicationService.Value.GetArrivalsReportSevenDayForecast(selectedDate);
        return Ok(arrivingStudents);
    }

如果您也希望看到前端,请随时阅读以下代码。不幸的是,那是用Angular编写的。通常,这就是我在Angular GET请求中将DateTime作为查询参数传递的方式。

public getArrivalsReportSevenDayForecast(selectedDate1 : Date): Observable<ArrivalsReportSevenDayForecastModel[]> {
const params = new HttpParams();
const day = selectedDate1.getDate();
const month = selectedDate1.getMonth() + 1
const year = selectedDate1.getFullYear();

const data = this.svcHttp.get<ArrivalsReportSevenDayForecastModel[]>(this.routePrefix +
  `/arrivalreportsevendayforecast/${day}/${month}/${year}`, { params: params }).pipe(
  map<ArrivalsReportSevenDayForecastModel[], ArrivalsReportSevenDayForecastModel[]>(arrivingList => {
    // do mapping here if needed       
    return arrivingList;
  }),
  catchError((err) => this.svcError.handleError(err)));

return data;
}

答案 9 :(得分:0)

一种可能的解决方案是使用Ticks:

公共长Ti { }

然后使用控制器的方法:

公共DateTime(长刻度);