在Spring中處理可選輸入RESTful API的最佳方法

我有一個爲使用情況數據庫創建的RESTful服務。必需的參數是開始日期&結束日期。操作參數是用戶名，客戶端ip & remote-ip。在Spring中處理可選輸入RESTful API的最佳方法

我有這個工作，但想看看有沒有實現一個更好的辦法：

這裏是我的資源類：

@RequestMapping(value = "/usage", method = RequestMethod.GET) 
@ApiOperation(value = "Usage Sessions - JSON Body", notes = "GET method for users by date range") 
public List<DTO> getUsageByDate(@RequestParam(value = "start-date", required = true) final String startDate, 
     @RequestParam(value = "end-date", required = true) final String endDate, 
     @RequestParam(value = "user-name", required = false) final String userName, 
     @RequestParam(value = "client-ip", required = false) final String clientIp, 
     @RequestParam(value = "remote-ip", required = false) final String nasIp) throws BadParameterException { 
    return aaaService.findUsageByDate(startDate, endDate, userName, clientIp,remoteIp); 

}

我的DAO實現看起來像：

public List<DTO> getUsageByDate(String startDate, String endDate, String userName, String localIp, String remoteIp) 
     throws BadParameterException { 
    StringBuilder sql = new StringBuilder(
      "select * from usage where process_time >= :start_date and process_time < :end_date"); 

    if(userName != null) { 
     sql.append(" AND user_name = :user_name"); 
    } 
    if(localIp != null) { 
     sql.append(" AND local_ip_address = :local_ip"); 
    } 
    if(remoteIp != null){ 
     sql.append(" AND remote_ip_address = :remote_ip"); 
    } 

    SqlParameterSource namedParameters = new MapSqlParameterSource().addValue("start_date", startDate) 
      .addValue("end_date", endDate).addValue("user_name", userName).addValue("local_ip", localIp) 
      .addValue("nas_ip", remoteIp); 

    try { 
     return jdbcTemplate.query(sql.toString(), namedParameters, 
       new BeanPropertyRowMapper<DTO>(DTO.class)); 

    } catch (EmptyResultDataAccessException e) { 
     throw new BadParameterException(); 
    } 
}

任何想法現在似乎有點長。

感謝

來源

2016-04-03 Xathras

required = true是默認值。對於那些可選的參數，您不需要添加必需的屬性。 – pczeus

感謝您的反饋。關於if語句的實現有沒有更好的方法？ – Xathras

我通常通過JSR303來做到這一點。你有沒有考慮過這個選項？ – dambros

進行必要的參數（開始日期，結束日期）的URI的和可選的參數（用戶名，客戶端IP，遠程IP）使用的查詢參數部分。所以你的URI可能是/usage/05.05.2015/06.06.2016?user-name=Joe。
用戶輸入驗證不應該在您的DAO中完成。它應該在REST控制器中完成。

你可以表達其參數是可選的，哪些是在getUsageByDate方法簽名強制性的，如果你使用Java 8：

public List<DTO> getUsageByDate(String startDate, String endDate, 
     Optional<String> userName, Optional<String> localIp, Optional<String> remoteIp)

您也應該驗證提供了所需的參數：

Objects.requireNonNull(startDate); 
Objects.requireNonNull(endDate);

您應該確保用戶提供的日期是有效的，並且您不應該將日期作爲字符串傳遞給您的DAO。

來源

2016-04-04 07:39:39

您的（1）刪除稍後確定日期參數是可選的功能。 –

@EricStein這是正確的。這是REST API表現力和自由改變它的能力之間的折衷。 –

在Spring中處理可選輸入RESTful API的最佳方法

回答

相關問題