Spring Boot基础

news2024/11/16 19:47:30

项目创建

项目启动

请求响应

RestController

1.返回值处理

@RestController:这个注解结合了@Controller和@ResponseBody的功能。它默认将所有处理请求的方法的返回值直接作为响应体内容返回,主要用于构建RESTful API。返回的数据格式通常是JSON或XML,这取决于请求中的Accept头部或配置的消息转换器。
Controller:这个注解的返回值通常会经过视图解析器解析,然后返回给用户一个渲染后的HTML页面。如果需要在Controller中返回JSON或XML数据,需要在方法上额外添加@ResponseBody注解。
2. 用途和场景

@RestController:主要用于构建RESTful Web服务,它简化了开发RESTful风格的控制器的代码,使得开发者能够更加专注于业务逻辑的实现,而无需关注底层的请求-响应处理细节。它支持get、post、put、delete等HTTP方法,适用于前后端分离的架构。
@Controller:更多地与视图渲染和页面跳转相关,适用于传统的MVC(Model-View-Controller)架构。通过页面模板引擎(如JSP、Thymeleaf等)将数据渲染成HTML页面返回给用户。
 

创建 HelloController.java

package org.example.myspringboot;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

// @RequestMapping("/api")
@RestController
public class HelloController {
    @RequestMapping("/hello")
    public String hello() {
        return "hello";
    }
}

请求 http://127.0.0.1:8080/hello 访问接口

增加 @RequestMapping("/api") 访问变成:http://127.0.0.1:8080/api/hello

RequestMapping

参数:

  • value 路由 默认 /
  • method 请求方式:默认GET
    RequestMethod.GET,RequestMethod.POST, RequestMethod.PUT, RequestMethod.DELETE
        @RequestMapping(value = "/hello", method = RequestMethod.DELETE)
    

RequestParam

 @RequestParam注解用于将HTTP请求中的参数绑定到方法的参数上

参数:

  • value 获取的字段名
  • required 字段值是否为必须,false为非必须
  • defaultValue 字段默认值

例如url: http://127.0.0.1:8080/api/hello?name=xx ,获取name的值

package org.example.myspringboot;

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.RestController;

@RequestMapping("/api")
@RestController
public class HelloController {
    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public String hello(@RequestParam(value = "name", required = false, defaultValue = "Alex") String name) {
        System.out.println(name);
        return "hello";
    }
}

处理多个参数

http://127.0.0.1:8080/api/hello?name=xx&age=18

package org.example.myspringboot;

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.RestController;


@RequestMapping("/api")
@RestController
public class HelloController {
    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public String hello(
            @RequestParam(value = "name") String name,
            @RequestParam(value = "age") Integer age
    ) {
        System.out.println(name + " " + age);
        return "hello";
    }
}

使用Map处理多个参数

package org.example.myspringboot;

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.RestController;

import java.util.Map;


@RequestMapping("/api")
@RestController
public class HelloController {
    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public String hello(Map<String, String> params) {
        String name = params.get("name");
        String age = params.get("age");
        System.out.println(name + " " + age);
        return "hello";
    }
}

使用List处理多个相同参数

http://127.0.0.1:8080/api/hello?name=xx&name=yy

package org.example.myspringboot;

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.RestController;

import java.util.List;
import java.util.Map;


@RequestMapping("/api")
@RestController
public class HelloController {
    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public String hello(@RequestParam List<String> name) {
        System.out.println(name);
        return "hello";
    }
}

PathVariable

@PathVariable注解获取url中的参数

http://127.0.0.1:8080/api/hello/100/Alex

package org.example.myspringboot;

import org.springframework.web.bind.annotation.*;

import java.util.List;
import java.util.Map;


@RequestMapping("/api")
@RestController
public class HelloController {
    @RequestMapping(value = "/hello/{id}/{name}", method = RequestMethod.GET)
    public String hello(@PathVariable String id, @PathVariable String name) {
        System.out.println(id);
        System.out.println(name);
        return "hello";
    }
}

RequestBody

@RequestBody注解:将JSON数据映射到形参的实体类对象中(JSON中的key和实体类中的属性名保持一致)

package org.example.myspringboot;

import org.springframework.web.bind.annotation.*;

@RestController
public class DataController {

    public static class Address{
        public String street;
        public String city;

//        public Address() {} // 添加无参构造函数
    }

    public static class User{
        public Integer id;
        public String name;
        public Integer age;
        public Address address;

//        public User() {}  // 添加无参构造函数
    }

    @RequestMapping(value = "user/{id}", method = {RequestMethod.POST, RequestMethod.GET})
    public String data(@RequestBody User user, @PathVariable Integer id){
        System.out.println(user.name);
        return "Hello World";
    }
}

 

@RequestBody User user 可以将 请求体中json数据映射到 User中

上传文件

package org.example.myspringboot;

import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import java.awt.*;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

@RestController
public class FilesController {

    private static final String UPLOAD_PATH = "uploads" ;

    @RequestMapping(value = "file", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
    public String files(@RequestParam("file") MultipartFile file) {
        try {
            Path uploadPath = Paths.get(UPLOAD_PATH);
            // 路径是否存在,不存在创建
            if (!Files.exists(uploadPath)) {
                Files.createDirectories(uploadPath);
            }
            String fileName = file.getOriginalFilename();
            // 保存文件
            Files.copy(file.getInputStream(), uploadPath.resolve(fileName));
            return UPLOAD_PATH + "/" + fileName;
        } catch (IOException e) {
            e.printStackTrace();
        }
        return "上传失败";
    }
}
private static final String UPLOAD_PATH = "uploads";

UPLOAD_DIR 是一个静态常量,其值为 "uploads"。这个变量用来指示文件上传的目标目录。让我们详细解释一下这段代码及其各个部分的意义:

常量定义

  • private: 这个关键字表示这个变量只能在定义它的类内部被访问。这是封装的一个体现,有助于保护数据不被外部直接修改。
  • static: 表示这是一个静态变量,即它是属于类的而不是实例的。这意味着所有该类的实例都将共享同一个UPLOAD_DIR的值。
  • final: 这个关键字表示这个变量是最终的,不可改变的。一旦赋值,就不能再重新赋值。在这个场景中,我们希望上传目录的路径是一次性设定好的,并且在整个应用程序运行期间保持不变。

作用

  1. 路径确定性: 使用常量可以确保上传目录的路径在应用启动时就被确定下来,这样每次上传操作都能知道文件应该保存在哪里。
  2. 可维护性: 如果将来需要更改上传目录,只需要修改这一个地方即可,不需要在整个应用中搜索并替换所有的路径字符串。
  3. 易读性和易理解: 声明为常量使得其他开发人员更容易理解这个字符串是用来做什么的,同时也使得代码更加清晰和易于维护。

使用final关键字有几个好处:

  1. 不可变性: 它保证了一旦给定一个值之后,这个值就不会被改变。这对于配置信息特别有用,因为配置项通常是固定的,在程序运行期间不应该改变。
  2. 线程安全性: 在多线程环境下,final变量提供了天然的可见性保证,因为它们在初始化后不会被修改,所有线程看到的都是相同的值。
  3. 性能优化: 编译器和JVM能够对final字段进行一些优化,因为它们知道这些字段的值不会改变。
consumes = MediaType.MULTIPART_FORM_DATA_VALUE

consumes属性的作用

consumes属性用于指定该方法能够消费(接受)哪种类型的HTTP请求体内容。这里MediaType.MULTIPART_FORM_DATA_VALUE指定了该方法期望接收的数据类型为multipart/form-data,这是一种常见的用于上传文件的媒体类型。

  • 指定支持的媒体类型consumes属性告诉Spring MVC框架,只有当请求的内容类型(Content-Type)与consumes指定的媒体类型匹配时,才会调用该方法来处理请求。
  • 消息转换器:Spring MVC使用消息转换器(Message Converters)来读取和写入请求/响应体。对于multipart/form-data类型的数据,Spring默认使用CommonsMultipartResolver或者StandardServletMultipartResolver来解析这类请求。
  • 自动绑定:当consumes指定为MediaType.MULTIPART_FORM_DATA_VALUE时,Spring可以自动将请求体中的数据绑定到方法参数上。例如,@RequestParam用于获取普通表单字段的值,而@RequestParam("file") MultipartFile则用于接收上传的文件
MultipartFile file

MultipartFile是一个特殊的类型,它扩展了Part接口,并且专门用于处理上传的文件。MultipartFile提供了访问上传文件的方法,如获取文件名、文件类型、读取文件内容等。

@RequestParam("file") MultipartFile file这一行代码的意思是:

  • @RequestParam("file"):这表明HTTP请求中必须包含一个名为"file"的参数。这个参数通常是由HTML表单中的<input type="file" name="file">标签发送过来的。
  • MultipartFile file:这个参数类型表明这个方法期望接收到的是一个上传的文件。Spring MVC会将"file"参数对应的文件内容封装成一个MultipartFile对象,并传递给这个方法参数。

下载文件

package org.example.myspringboot;

import org.springframework.core.io.InputStreamResource;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

@RestController
public class FilesController {

    private static final String UPLOAD_PATH = "/Users/apple/Downloads";


    @GetMapping("file/{fileName}/download")
    public ResponseEntity<InputStreamResource> downloadFile(@PathVariable String fileName) throws IOException {
        Path path = Paths.get(UPLOAD_PATH + "/" + fileName);
        if (!Files.exists(path)) {
            return ResponseEntity.notFound().build();
        }
        File file = new File(String.valueOf(path));
        InputStreamResource resource = new InputStreamResource(new FileInputStream(file));
        HttpHeaders headers = new HttpHeaders();
        headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + file.getName() + "\"");
        headers.add(HttpHeaders.CONTENT_TYPE, "application/octet-stream");
        return ResponseEntity.ok().headers(headers).body(resource);
    }

    @RequestMapping("file/{fileName}/preview")
    public ResponseEntity<Resource> previewFile(@PathVariable String fileName) throws IOException {
        Path path = Paths.get(UPLOAD_PATH + "/" + fileName);
        Resource imageFile = new UrlResource(path.toUri());
        if (!imageFile.exists() && !imageFile.isReadable()) {
            return ResponseEntity.notFound().build();
        }
        String contentType = Files.probeContentType(path);
        if (contentType == null) {
            return ResponseEntity.notFound().build();
        }
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.parseMediaType(contentType));
        return ResponseEntity.ok().headers(headers).body(imageFile);
    }
}

返回静态页面

package org.example.myspringboot;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class IndexController {
    @RequestMapping
    public String index() {
        return "/index.html";
    }
}

ResponseBody

@responseBody注解的作用是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后,写入到response对象的body区,通常用来返回JSON数据或者是XML数据

ResponseEntity

ResponseEntity可以更灵活地处理HTTP响应,而不仅仅局限于返回简单的数据类型

返回string

    @RequestMapping(value = "user", method = {RequestMethod.POST, RequestMethod.GET})
    public ResponseEntity<String> data(){
        System.out.println(user.name);
        return ResponseEntity.ok()
                .header("Content-Type", "application/json")
                .body("提交成功");
    }

返回自定义类型

package org.example.myspringboot;

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

@RestController
public class DataController {

    public static class Address{
        public String street;
        public String city;
    }

    public static class User{
        public Integer id;
        public String name;
        public Integer age;
        public Address address;
    }

    @RequestMapping(value = "user/{id}", method = {RequestMethod.POST, RequestMethod.GET})
    public ResponseEntity<User> data(@RequestBody User user, @PathVariable Integer id){
        System.out.println(user.name);
        return ResponseEntity.ok()
                .header("Content-Type", "application/json")
                .body(user);
    }
}

设置响应状态码

    @RequestMapping(value = "user", method = {RequestMethod.POST, RequestMethod.GET})
    public ResponseEntity<String> data(){
        System.out.println(user.name);
        return ResponseEntity.status(HttpStatus.NOT_FOUND)
                .header("Content-Type", "application/json")
                .body("未来找到数据");
    }

参考

Java Spring Boot 全面教程_java springboot-CSDN博客

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2133687.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

vue使用TreeSelect设置带所有父级节点的回显

Element Plus的el-tree-select组件 思路&#xff1a; 选中节点时&#xff0c;给选中的节点赋值 pathLabel&#xff0c;pathLabel 为函数生成的节点名字拼接&#xff0c;数据源中不包含。 在el-tree-select组件中设置 props“{ label: ‘pathLabel’ }” 控制选中时input框中回…

商务办公tips1:如何将网页转换为pdf

​ 场景需求&#xff1a; 商务轻办公人士获取网页内容&#xff0c;并且最好是pdf版本&#xff1f; 将网页转换为PDF的需求可能出现在多种场景中&#xff0c;以下是一些可能的情况&#xff1a; 学术研究&#xff1a;研究人员可能需要将某个学术网站的全文内容保存为PDF格式&a…

sqlgun靶场训练

1.看到php&#xff1f;id &#xff0c;然后刚好有个框&#xff0c;直接测试sql注入 2.发现输入1 union select 1,2,3#的时候在2处有回显 3.查看表名 -1 union select 1,group_concat(table_name),3 from information_schema.tables where table_schemadatabase()# 4.查看列名…

【计网】从零开始使用UDP进行socket编程 --- 客户端与服务端的通信实现

人生不过如此&#xff0c;且行且珍惜。 自己永远是自己的主角&#xff0c; 不要总在别人的戏剧里充当着配角。 --- 林语堂 --- 从零开始学习socket编程---UDP协议 1 客户端与服务端的通信2 设计UDP服务器类2.1 基础框架设计2.2 初始化函数2.3 启动函数 3 设计客户端 1 客户…

会员计次卡渲染技术-—SAAS本地化及未来之窗行业应用跨平台架构

一、计次卡应用 1. 健身中心&#xff1a;会员购买一定次数的健身课程或使用健身房设施的权限。 2. 美容美发店&#xff1a;提供一定次数的理发、美容护理等服务。 3. 洗车店&#xff1a;车主购买若干次的洗车服务。 4. 儿童游乐场&#xff1a;家长为孩子购买固定次数的入场游…

分类预测|基于差分优化DE-支持向量机数据分类预测完整Matlab程序 DE-SVM

分类预测|基于差分优化DE-支持向量机数据分类预测完整Matlab程序 DE-SVM 文章目录 一、基本原理DE-SVM 分类预测原理和流程总结 二、实验结果三、核心代码四、代码获取五、总结 一、基本原理 DE-SVM 分类预测原理和流程 1. 差分进化优化算法&#xff08;DE&#xff09; 原理…

跟《经济学人》学英文:2024年09月07日这期 How fashion conquered television

How fashion conquered television More and more shows celebrate fancy clothes. Often brands call the shots 原文&#xff1a; From Tokyo to Seoul, on to New York, London, Milan and Paris, there are more “fashion weeks” in September than there are weeks i…

【Pandas操作2】groupby函数、pivot_table函数、数据运算(map和apply)、重复值清洗、异常值清洗、缺失值处理

1 数据清洗 #### 概述数据清洗是指对原始数据进行处理和转换&#xff0c;以去除无效、重复、缺失或错误的数据&#xff0c;使数据符合分析的要求。#### 作用和意义- 提高数据质量&#xff1a;- 通过数据清洗&#xff0c;数据质量得到提升&#xff0c;减少错误分析和错误决策。…

sharding-jdbc metadata load优化(4.1.1版本)

背景 系统启动时&#xff0c;会注意sharding-jdbc提示加载metadata 于是想看看里面做了什么事情 问题追踪 debug后可以观察走到了该类 org.apache.shardingsphere.shardingjdbc.jdbc.core.context.ShardingRuntimeContext#loadSchemaMetaData 先看这个shardingRuntimeConte…

玉米种子质量检测系统源码分享

玉米种子质量检测检测系统源码分享 [一条龙教学YOLOV8标注好的数据集一键训练_70全套改进创新点发刊_Web前端展示] 1.研究背景与意义 项目参考AAAI Association for the Advancement of Artificial Intelligence 项目来源AACV Association for the Advancement of Computer…

数据结构——栈和队列(队列的定义、顺序队列以及链式队列的基本操作)

目录 队列&#xff08;queue&#xff09;的定义 顺序队——队列的顺序表示和实现 顺序队列&#xff08;循环队列&#xff09;的类型定义 顺序队列上溢问题的解决方法 ​编辑 循环队列的基本操作 队列的基本操作——队列的初始化 队列的基本操作——求队列的长度 队列的…

[数据集][目标检测]岩石种类检测数据集VOC+YOLO格式4766张9类别

数据集格式&#xff1a;Pascal VOC格式YOLO格式(不包含分割路径的txt文件&#xff0c;仅仅包含jpg图片以及对应的VOC格式xml文件和yolo格式txt文件) 图片数量(jpg文件个数)&#xff1a;4766 标注数量(xml文件个数)&#xff1a;4766 标注数量(txt文件个数)&#xff1a;4766 标注…

CurrentHashMap的底层原理

CurrentHashMap在jdk1.8之前使用的是分段锁&#xff0c;在jdk1.8中使用"CAS和synchronized"来保证线程安全。 jdk1.8之前的底层实现 CurrentHashMap在jdk1.8之前&#xff0c;通过Segment段来实现线程安全。 Segment 段 ConcurrentHashMap 和 HashMap 思路是差不多…

TDengine 签约前晨汽车,解锁智能出行的无限潜力

在全球汽车产业转型升级的背景下&#xff0c;智能网联和新能源技术正迅速成为商用车行业的重要发展方向。随着市场对环保和智能化需求的日益增强&#xff0c;企业必须在技术创新和数据管理上不断突破&#xff0c;以满足客户对高效、安全和智能出行的期待。在这一背景下&#xf…

如何通过 PhantomJS 模拟用户行为抓取动态网页内容

引言 随着网页技术的不断进步&#xff0c;JavaScript 动态加载内容已成为网站设计的新常态&#xff0c;这对传统的静态网页抓取方法提出了挑战。为了应对这一挑战&#xff0c;PhantomJS 作为一个无头浏览器&#xff0c;能够模拟用户行为并执行 JavaScript&#xff0c;成为了获…

探索数据结构:初入算法之经典排序算法

&#x1f511;&#x1f511;博客主页&#xff1a;阿客不是客 &#x1f353;&#x1f353;系列专栏&#xff1a;渐入佳境之数据结构与算法 欢迎来到泊舟小课堂 &#x1f618;博客制作不易欢迎各位&#x1f44d;点赞⭐收藏➕关注 一、插入排序 步骤&#xff1a; 从第一个元素开…

OpenAI 刚刚推出 o1 大模型!!突破LLM极限

北京时间 9 月 13 日午夜&#xff0c;OpenAI 正式发布了一系列全新的 AI 大模型&#xff0c;专门用于应对复杂问题。 这一新模型的出现代表了一个重要突破&#xff0c;其具备的复杂推理能力远远超过了以往用于科学、代码和数学等领域的通用模型&#xff0c;能够解决比之前更难的…

Python和R均方根误差平均绝对误差算法模型

&#x1f3af;要点 回归模型误差评估指标归一化均方根误差生态状态指标神经网络成本误差计算气体排放气候算法模型 Python误差指标 均方根误差和平均绝对误差 均方根偏差或均方根误差是两个密切相关且经常使用的度量值之一&#xff0c;用于衡量真实值或预测值与观测值或估…

HarmonyOS开发实战( Beta5.0)骨架屏实现案例实践

鸿蒙HarmonyOS开发往期必看&#xff1a; HarmonyOS NEXT应用开发性能实践总结 最新版&#xff01;“非常详细的” 鸿蒙HarmonyOS Next应用开发学习路线&#xff01;&#xff08;从零基础入门到精通&#xff09; 介绍 本示例介绍通过骨架屏提升加载时用户体验的方法。骨架屏用…

无法加载用户配置文件怎么解决?

你有没有遇到过这种问题&#xff0c;蓝屏提示“User Profile Services服务登录失败。无法加载用户配置文件”。为什么会出现问题呢&#xff1f;可能的原因包括&#xff1a; 用户配置文件损坏&#xff1a;用户的配置文件可能已损坏&#xff0c;导致系统无法读取。 权限问题&…