Spring Boot 实现RESTful webservice服务端示例

以你之姓@ 2022-06-05 07:40 235阅读 0赞

1.Spring Boot configurations   
application.yml

spring:
      profiles:
        active: dev
      mvc:
        favicon:
          enabled: false
      datasource:
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://localhost:3306/wit_neptune?createDatabaseIfNotExist=true&useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&transformedBitIsBoolean=true
        username: root
        password: 123456
      jpa:
        hibernate:
          ddl-auto: update
        show-sql: true

2.Spring Boot Application   
WitApp.java

3.Rest Controller   
WitUserRest.java

/* * Copyright 2016-2017 WitPool.org All Rights Reserved. * * You may not use this file except in compliance with the License. * A copy of the License is located at * http://www.witpool.org/licenses * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */
    package org.witpool.rest;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.DeleteMapping;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.PutMapping;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    import org.witpool.common.enums.WitCode;
    import org.witpool.common.model.bean.WitResult;
    import org.witpool.common.model.po.WitUser;
    import org.witpool.common.util.WitUtil;
    import org.witpool.persist.WitRepository;
    import org.witpool.service.WitService;
    
    /** * @Class Name : WitUserRest * @Description: WitPool User Rest * @Author : Dom Wang * @Email : witpool@outlook.com * @Date : 2017-11-15 PM 2:50:27 * @Version : 1.0 */
    @RestController
    @RequestMapping("/users")
    public class WitUserRest { 
        private final static Logger log = LoggerFactory.getLogger(WitUserRest.class);
    
        @Autowired
        private WitRepository reposit;
    
        @Autowired
        private WitService service;
    
        /** * * @Title: addUser * @Description: Add one user * @param @param user * @param @return * @return WitResult<WitUser> * @throws */
        @PostMapping
        public WitResult<WitUser> addUser(@RequestBody WitUser user)
        {
            return WitUtil.success(reposit.save(user));
        }
    
        /** * * @Title: addUsers * @Description: Add users by specified number * @param @param num * @param @return * @return WitResult<WitUser> * @throws */
        @PostMapping(value = "/{number}")
        public WitResult<WitUser> addUsers(@PathVariable("number") Integer num)
        {
            if (num < 0 || num > 10)
            {
                log.error("The number should be [0, 10]");
                return WitUtil.failure(WitCode.WIT_ERR_INVALID_PARAM);
            }
            return WitUtil.success(service.addUsers(num));
        }
    
        /** * * @Title: updateUser * @Description: Update user * @param @param user * @param @return * @return WitResult<WitUser> * @throws */
        @PutMapping
        public WitResult<WitUser> updateUser(@RequestBody WitUser user)
        {
            return WitUtil.success(reposit.save(user));
        }
    
        /** * * @Title: deleteUser * @Description: delete user by ID * @param @param userId * @param @return * @return WitResult<WitUser> * @throws */
        @DeleteMapping(value = "/{userId}")
        public WitResult<WitUser> deleteUser(@PathVariable("userId") Integer userId)
        {
            reposit.delete(userId);
            return WitUtil.success();
        }
    
        /** * * @Title: getUserByID * @Description: Get user by ID * @param @param userId * @param @return * @return WitResult<WitUser> * @throws */
        @GetMapping(value = "/{userId}")
        public WitResult<WitUser> getUserByID(@PathVariable("userId") Integer userId)
        {
            return WitUtil.success(reposit.findOne(userId));
        }
    
        /** * * @Title: getUserByName * @Description: Get user by name * @param @param userName * @param @return * @return WitResult<WitUser> * @throws */
        @GetMapping(value = "/name/{userName}")
        public WitResult<WitUser> getUserByName(@PathVariable("userName") String userName)
        {
            return WitUtil.success(reposit.findByUserName(userName));
        }
    
        /** * * @Title: getUsers * @Description: Get all users * @param @return * @return WitResult<WitUser> * @throws */
        @GetMapping
        public WitResult<WitUser> getUsers()
        {
            return WitUtil.success(reposit.findAll());
        }
    }

4.Aspect   
WitAspect.java

5.Controller Advice   
WitExceptHandle.java

6.Jpa Repository   
WitRepository.java

7.代码下载、编译、打包   
代码下载请访问 GitHub上的 [witpool/Wit-Neptune][witpool_Wit-Neptune]   
导入工程文件、编译、打包步骤如下：   
Eclipse 导入maven工程   
![导入Maven工程][Maven]

Maven打包   
![Maven install打包][Maven install]

![生成的JAR包][JAR]

8.启动和UT步骤   
启动应用：java -jar wit-rest-1.0.jar   
![启动应用][SouthEast]

UT步骤：   
(1). 下载[WisdomTool REST Client][]   
(2). 双击 JAR包 restclient-1.1.jar 启动工具   
导入[测试用例文件][Link 1]：   
![WisdomTool RESTClient][]

原文链接：http://geek.csdn.net/news/detail/244296

[witpool_Wit-Neptune]: https://github.com/witpool/Wit-Neptune
[Maven]: /images/20220605/621bc6277e884efba74add176ee19554.png
[Maven install]: /images/20220605/7fd6f59df1554578b7088904e88364fe.png
[JAR]: /images/20220605/767cf8d30dc44f4a8554b362698c680e.png
[SouthEast]: /images/20220605/34862957593b4ea9ae5e9540be12ebd7.png
[WisdomTool REST Client]: https://github.com/wisdomtool/rest-client
[Link 1]: https://github.com/witpool/Wit-Neptune/blob/master/Wit-Neptune-Cases.json
[WisdomTool RESTClient]: /images/20220605/86368178f7604db187a249b915841269.png