springBoot中Contoller的注解用法（文件上傳、下載、路徑參數等）

 

    以下是springBoot中Contoller層的各種情況注解使用。

    @RestController

    @RequestMapping

    @PostMapping

    @RequestBody

    @ResponseBody

    @PathParam

    @RequestParam

 

package com.cheng2839.controller;

import org.apache.commons.lang.CharEncoding;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.websocket.server.PathParam;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.util.Arrays;

/**
 * @RestController 表示是一個Controller，以json方式輸出
 * @RequestMapping 表示路徑前綴
 */
@RestController
@RequestMapping("/root")
public class MyTestController {

    /**
     * 普通的使用包裝對象作為入參，使用@RequestBody
     * @PostMapping 表示Post請求
     *
     * @param testVo
     * @return
     */
    @PostMapping(value = "/test1", produces = "application/json")
    public String test1(@RequestBody TestVo testVo) {
        try {
            return "success";
        } catch (Exception e) {
            return "error";
        }
    }

    /**
     * @ResponseBody 表示響應以json對象輸出，和@Controller同時使用，由於此類是用@RestController修飾，所以可以省略@ResponseBody了
     * @RequestMapping 可以指定請求字符集、請求方式等
     * @PathVariable 表示path后的/帶的路徑參數
     * @param id
     * @return
     */
    //@ResponseBody
    @RequestMapping(path = "/test2/{id}", method = RequestMethod.POST, produces = "application/json")
    public String test2(@PathVariable(name = "id") String id) {
        return id;
    }

    /**
     * @PathParam 表示請求地址后？中帶的參數值
     * @param token
     * @return
     */
    @RequestMapping(path = "/test3", method = RequestMethod.GET, produces = "application/json")
    public String test3(@PathParam(value = "token") String token) {
        return token;
    }

    /**
     * 適用於下載文件時用
     * @param request
     * @param response
     * @return
     * @throws IOException
     */
    @RequestMapping(path = "/test4", method = RequestMethod.GET, produces = "application/json")
    public String test4(HttpServletRequest request, HttpServletResponse response) throws IOException {
        String token = request.getHeader("token");  //獲取header內容
        boolean type = (Boolean) request.getSession().getAttribute("type"); //獲取session中值
        Cookie[] cookies = request.getCookies();  //獲取cookie內容

        //輸出數據
        String stringData = new String("token="+token+";cookies="+ Arrays.toString(cookies));
        byte[] bytes = stringData.getBytes(CharEncoding.UTF_8);

        //以流的方式輸出（下載）
        if (type) {
            OutputStream os = response.getOutputStream();
            os.write(bytes);
            os.flush();
            os.close();
        } else {
            //以文字的方式輸出
            PrintWriter writer = response.getWriter();
            writer.print(stringData); //響應值
        }
        return "success";
    }


    /**
     * 適用於上傳文件時用(在form-data中放入文件，名稱為file)
     * @RequestParam 表示通過form表單提交的參數對象
     * @return
     * @throws IOException
     */
    @RequestMapping(path = "/test5", method = RequestMethod.GET, produces = "application/x-www-form-urlencoded")
    public String test5(@RequestParam(value = "file", required = false) MultipartFile multipartFile) throws IOException{
        InputStream inputStream = multipartFile.getInputStream();
        File cloudFile = new File("/mnt/cheng2839/files/"+System.currentTimeMillis()+multipartFile.getOriginalFilename());
        FileOutputStream fileOutputStream = new FileOutputStream(cloudFile);
        byte[] buf = new byte[1024];
        int len = -1;
        while ((len=inputStream.read(buf))>0) {
            fileOutputStream.write(buf, 0, len);
        }
        fileOutputStream.flush();
        fileOutputStream.close();
        inputStream.close();
        return "success";
    }


    class TestVo {
        private String name;
        private String account;
        // getter and setter functions
    }

}