Restful接口开发（2）：RestController详解-基础

一、日志级别

使用commons.logging记录日志
1.日志级别

 TRACE<DEBUG<INFO<WARN<ERROR<FATAL

2.配置文件..demo\src\main\resources\application.yml配置日志输出级别为TRACE

spring:
  jackson:
    date-format: yyyy-MM-dd #如果使用字符串型表示，用这行设置
    timezone: GMT+8
    serialization:
      write-dates-as-timestamps: false #使用数值timestamp表示日期,false表示不用这数字；true表示用数字
logging:
  file: target/app.log
  level:
    ROOT: WARN
    com.example.demo: TRACE

备注：
（1）配置日志级别：TRACE<DEBUG<INFO<WARN<ERROR<FATAL
（2）com.example.demo 为对应包的名称，这个依据自己包名修改

3.代码

package com.example.demo;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.*;

@RestController
public class HelloworldController {
    //创建日志静态对象
    private static final Log log= LogFactory.getLog(HelloworldController.class);

//    @GetMapping
    @RequestMapping("/helloworld")
    public Map<String,Object> sayHelloworld(){
        Map<String,Object> result=new HashMap<>();
        result.put("message","hello world!");
        result.put("message2","hello world 2!");
        result.put("message3","hello world 3!");
        return result;
    }

    /**
     * 获取所有电视节目列表
     * @return
     */
    @RequestMapping("/getall")
    public List<TvSeriesDto> getAll(){
        //TRACE
        if(log.isTraceEnabled()){
            log.trace("getAll函数被调用了！");
        }

        //ERROR
        try{

        }catch (Exception e){
            if(log.isErrorEnabled()){
                log.error("出错了:"+e);
            }

        }
        List<TvSeriesDto> list=new ArrayList<>();
        Calendar calendar=Calendar.getInstance();
        calendar.set(2016,Calendar.OCTOBER,12,2,0);
        list.add( new TvSeriesDto(1,"WestWorld",1,calendar.getTime()));
        return list;
    }

}

备注：

（1）输出日志，先判断是否需要输出；
（2）日志输出结果：
2019-09-03 00:53:20.585 TRACE 9352 --- [nio-8080-exec-1] com.example.demo.HelloworldController    : getAll函数被调用了！

（3）日志输出位置：target/app.log
 
4.    修改日志级别为WARN
 
访问网站http://localhost:8080/getall，结果日志什么也没有出。

二、API测试工具postman

1.下载地址https://www.getpostman.com/apps

2.安装
 
3.测试
选择post，输入url然后点击发送，会返回服务器数据。
 

三、RestController获取各种数据（增删改查）

1.get（查询）
 （1）代码

    /**
     * 1.GET获取所有电视节目列表
     * @return
     */
//    @RequestMapping("/getall")
    @GetMapping()
    public List<TvSeriesDto> getAll(){
        //TRACE
        if(log.isTraceEnabled()){
            log.trace("getAll函数被调用了！");
        }

        //ERROR
        try{

        }catch (Exception e){
            if(log.isErrorEnabled()){
                log.error("出错了:"+e);
            }

        }
        List<TvSeriesDto> list=new ArrayList<>();
        Calendar calendar=Calendar.getInstance();
        calendar.set(2016,Calendar.OCTOBER,12,2,0);
        list.add( new TvSeriesDto(1,"WestWorld",1,calendar.getTime()));
        return list;
    }

/**
 * 创建返回Person of Interest
 * @return
 */
private TvSeriesDto createPoi(){
    Calendar calendar=Calendar.getInstance();
    calendar.set(2016,Calendar.OCTOBER,12,2,0);
    return new TvSeriesDto(1,"Person of Interest",1,calendar.getTime());

}

/**
 * 创建返回WestWorld实例
 * @return
 */
private TvSeriesDto createWestWorld(){
    Calendar calendar=Calendar.getInstance();
    calendar.set(2015,Calendar.OCTOBER,2,2,0);
    return new TvSeriesDto(2,"WestWorld",1,calendar.getTime());

}

（2）测试
 

2.post（插入）

 （1）代码

/**
 * 2.post方法
 * @param tvSeriesDto
 * @return
 */
@PostMapping
private TvSeriesDto insertOne(@RequestBody TvSeriesDto tvSeriesDto){
    if(log.isTraceEnabled()){
        log.trace("适应post添加TvSeriesDto对象到数据库代码，传进来的参数是："+tvSeriesDto);
    }
    //TODO:传递数据
    tvSeriesDto.setId(99999);
    return tvSeriesDto;
}

（2）修改类TvSeriesDto.java，重写方法toString

（3）点击测试通过！
-》配置HEADER
 
-》配置body

-》结果

3.Put（更新）
 （1）代码

    /**
     * 3.更新
     * @param id
     * @param tvSeriesDto 输入参数类
     * @return
     */
    @PutMapping("/{id}")
    public TvSeriesDto updateOne(@PathVariable int id,@RequestBody TvSeriesDto tvSeriesDto){
        if(log.isTraceEnabled()){
            log.trace("updateOne"+id);
        }
        if(id==101||id ==102){
            //todo: 根据tvSeriesDto的内容更新数据库，更新后返回新值
            return createPoi();
        }else {
//            throw new ResourceNotFoundException("404",new Re);
            return null;
        }

    }

（2）测试

-》更新id=101

-》更新id=103

4. delete类似get（删除）
（1）代码

/**
 * 4.删除
 * @param id
 * @param request
 * @param deleteReason
 * @return
 * @throws Exception
 */
@DeleteMapping("/{id}")
public Map<String,String> deleteOne(@PathVariable int id, HttpServletRequest request,
                                    @RequestParam(value="delete_reason",required = false) String deleteReason) throws Exception{

    if(log.isTraceEnabled()){
        log.trace("deleteOne:"+id);
    }
    Map<String,String> result=new HashMap<>();
    if(id==101){
        //TODO:执行删除的代码
        result.put("message","#101被"+request.getRemoteAddr()+"删除。（原因："+deleteReason+")");
    }else if(id ==102){
        throw new RuntimeException("#102不能删除");
    }else{
        //不存在

    }
    return result;

}

（2）测试结果，删除101