{"id":787,"date":"2013-10-18T13:49:59","date_gmt":"2013-10-18T20:49:59","guid":{"rendered":"http:\/\/10kdev.net\/?p=787"},"modified":"2013-10-23T04:59:30","modified_gmt":"2013-10-23T11:59:30","slug":"optional-path-variables-in-spring-web-mvc","status":"publish","type":"post","link":"http:\/\/10kdev.net\/?p=787","title":{"rendered":"Optional Path Variables in Spring Web MVC"},"content":{"rendered":"

With a Spring Web MVC controller endpoint in Java you cannot have an optional @PathVariable, so you have to do things old school. In my code I wanted a default sorting mechanism, if the caller of my endpoint didn’t put in any sort parameters. The sort (orderBy) parameters are the fields, and the direction of the sort is specified in an already provided Spring enumeration that I pass a string value to.<\/p>\n

The whole *secret* — just pass the HttpServletRequest object into the controller method. \u00a0That’s it.<\/p><\/blockquote>\n

Note my setup is Spring core libraries (and MVC) 3.2.4, Spring Data JPA 1.4.1, and Hibernate for the dialect version 4.2.1 with JPA Api 1.0.1.<\/p>\n

Endpoint in the Controller:<\/p>\n

@ApiOperation(value=“look for list by sorting”, <\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0 notes= ” two optional parameters: orderBy = {fieldA, fieldB, fieldC} “<\/span>
\n<\/span><\/p>\n

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 + “direction = {ASC,DESC}”)<\/span><\/span><\/span><\/p>\n

@RequestMapping(method = RequestMethod.GET<\/em>, value = “\/look”)<\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

public<\/strong>
\n@ResponseBody<\/span>
\n<\/span><\/span><\/span><\/p>\n

List<ObjectDto> findSorted(HttpServletRequest request) {<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0return\u00a0<\/strong>dataService<\/span>.findSorted (request.getParameter(“orderBy”), request.getParameter(“direction”));<\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

}<\/span><\/p>\n

This calls the service, which builds a Pageable object. I haven’t had a need to refactor the method so I just left the code in the service method for now. There are a few ternaries to check for nulls (note: PMD has a base rule to not reuse method parms as well).<\/p>\n

Method in the Service:<\/p>\n

private<\/strong>
\nfinal<\/strong>
\nstatic<\/strong> String DEFAULT_ORDER<\/em> = “fieldA”;<\/span>
\n<\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

private<\/strong>
\nfinal<\/strong>
\nstatic<\/strong> String DEFAULT_DIRECTION<\/em> = “<\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/span>ASC<\/span>“;
\n<\/span><\/span><\/span><\/p>\n

public<\/strong> List<Object> getEntities(Pageable pageable) {<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0return\u00a0<\/strong>objectRepository<\/span>.findAll(pageable).getContent();<\/span><\/span><\/span><\/span><\/p>\n

}<\/span>
\n<\/span><\/p>\n

public<\/strong> List<ObjectDto> getDTOs(Pageable pageable) {<\/span>
\n<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0return\u00a0<\/strong>objectMapper<\/span>.toDTOs(getEntities(pageable), ObjectDto.class<\/strong>);<\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

}<\/span><\/p>\n

public<\/strong> List< ObjectDto > findSorted (String orderBy, String direction) {<\/span>
\n<\/span><\/p>\n

String order = orderBy == null<\/strong> ? DEFAULT_ORDER<\/em> : orderBy;<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

String dir = direction == null<\/strong> ? DEFAULT_DIRECTION<\/em> : direction;<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n


\nfinal<\/strong> PageRequest pageable = new<\/strong> PageRequest(<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0 0, Paging.PAGING_SIZE<\/em>, new<\/strong> Sort(<\/span>
\n<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0 new<\/strong> Order(Direction.fromString<\/em>(dir), order)));<\/span><\/span><\/span><\/p>\n

return\u00a0<\/strong>objectService<\/span>.getDTOs (pageable);<\/span><\/span><\/span><\/span><\/p>\n

}<\/span><\/p>\n

The mapper code is simple, using commons BeanUtils:<\/p>\n

\u00a0\u00a0\u00a0\u00a0BeanUtils.copyProperties<\/em>(fromEntity, toDto);<\/span>
\n<\/span><\/p>\n

And the repository code extends JPARepository, so there is already a findAll(pageable) function in the canned interface.<\/p>\n","protected":false},"excerpt":{"rendered":"

With a Spring Web MVC controller endpoint in Java you cannot have an optional @PathVariable, so you have to do things old school. In my code I wanted a default sorting mechanism, if the caller of my endpoint didn’t put in any sort parameters. The sort (orderBy) parameters are the fields, and the direction of […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"_links":{"self":[{"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/posts\/787"}],"collection":[{"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"http:\/\/10kdev.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=787"}],"version-history":[{"count":8,"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/posts\/787\/revisions"}],"predecessor-version":[{"id":806,"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/posts\/787\/revisions\/806"}],"wp:attachment":[{"href":"http:\/\/10kdev.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=787"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/10kdev.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=787"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/10kdev.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=787"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}