【06】SpringBoot与Web开发

最新推荐文章于 2024-07-10 22:19:54 发布
最新推荐文章于 2024-07-10 22:19:54 发布
阅读量909 收藏 28
点赞数 26
分类专栏： # SpringBoot 文章标签： spring boot 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/XQ_898878888/article/details/140053277
版权

1、基于Restful风格的接口

@RestController
@RequestMapping("/demo")
public class DemoController {

    @GetMapping("/hello")
    public String getHello(){
        return "SpringBoot HelloWorld! 123";
    }

    @GetMapping("/{id}")
    public User getUser(@PathVariable Integer id){
        Map<Integer, User> userMap = new HashMap<>();
        userMap.put(1,new User("张一"));
        userMap.put(2,new User("张二"));
        userMap.put(3,new User("张三"));
        return userMap.get(id);
    }

    @PostMapping("/add")
    public Map<String,Object> addUser(@RequestBody User user) {
        Map<String, Object> map = new HashMap<>();
        map.put("code", 200);
        map.put("msg", "添加成功");
        System.out.println(user);
        return map;
    }

    @PutMapping("/update")
    public Map<String,Object> updateUser(@RequestBody User user) {
        Map<String, Object> map = new HashMap<>();
        map.put("code", 200);
        map.put("msg", "修改成功");
        System.out.println(user);
        return map;
    }

    @DeleteMapping("/delete/{id}")
    public Map<String,Object> deleteUser(@PathVariable Integer id) {
        Map<String, Object> map = new HashMap<>();
        map.put("code", 200);
        map.put("msg", "删除成功");
        System.out.println(id);
        return map;
    }

2、使用RestTemplate请求接口

  • RestTemplate是Spring提供的，用于访问Rest服务的，提供了许多便捷访问远程Http服务的方法。
  • 传统情况下在Java代码里访问restful服务，一般使用Apache的HttpClient。由于此种方法使用起来太过繁琐，所以，Spring提供了一种简单、便捷的模板类来进行操作，它就是RestTemplate。
@RestController
@RequestMapping("/rest")
public class RestTemController {

    private RestTemplate restTemplate;

    //当bean没有无参构造函数时，Spring将自动拿到有参的构造函数，参数进行自动注入
    public RestTemController(RestTemplateBuilder restTemplateBuilder) {
        this.restTemplate = restTemplateBuilder.build();
    }

    /**
     * 使用RestTemplate发送请求,查询数据
     * @return
     */
    @RequestMapping("/testRestQuery")
    public String testRestTemplate1() {
        Integer id = 1;
        User user = restTemplate.getForObject("http://localhost:8091/springboot_dev/demo/{id}", User.class,id);
        //另一种get请求的方法
        //restTemplate.getForEntity()
        if (user != null) {
            return user.toString();
        }
        return "用户不存在";
    }

    /**
     * 使用RestTemplate发送请求,获取数据
     * @return
     */
    @RequestMapping("/testRestAdd")
    public String testRestTemplate2() {

        User user = new User("张三", 20, new Date(),"北京市海淀区", Arrays.asList("打球", "跑步", "钓鱼"), new HashMap<String, Object>() {{
            put("朋友1", "小明");
            put("朋友2", "小花");
            put("朋友3", "小张");
        }});

        //url：需要请求的远程url
        //Object ：请求需要发送的数据
        //Class<T> ：请求返回的数据类型
        //....Object：请求url中需要替换的占位符
        ResponseEntity<Map> responseEntity = restTemplate.postForEntity("http://localhost:8091/springboot_dev/demo/add", user, Map.class);
        return Objects.requireNonNull(responseEntity.getBody()).toString();
    }

    /**
     * 使用RestTemplate发送请求,修改数据
     * @return
     */
    @RequestMapping("/testRestUpdate")
    public String testRestTemplate3() {
        User user = new User("张四", 20, new Date(),"西安市海淀区", Arrays.asList("打球", "跑步", "钓鱼"), new HashMap<String, Object>() {{
            put("朋友1", "小明");
            put("朋友2", "小花");
            put("朋友3", "小张");
        }});
        restTemplate.put("http://localhost:8091/springboot_dev/demo/update", user);
        return "成功修改";
    }


    /**
     * 使用RestTemplate发送请求,修改数据(运用exchange，支持任何请求方法类型)
     * @return
     */
    @RequestMapping("/testRestUpdate2")
    public String testRestTemplate4() {
        User user = new User("张四", 20, new Date(),"西安市海淀区", Arrays.asList("打球", "跑步", "钓鱼"), new HashMap<String, Object>() {{
            put("朋友1", "小明");
            put("朋友2", "小花");
            put("朋友3", "小张");
        }});

        //请求参数封装
        HttpEntity<User> httpEntity = new HttpEntity<>(user);
        //发送请求同时获取请求响应
        ResponseEntity<Map> response = restTemplate.exchange("http://localhost:8091/springboot_dev/demo/update", HttpMethod.PUT, httpEntity, Map.class);
        return Objects.requireNonNull(response.getBody()).toString();
    }

    /**
     * 使用RestTemplate发送请求,删除数据（运用exchange）
     * @return
     */
    @RequestMapping("/testRestDelete")
    public String testRestTemplate5() {
        Integer id = 1;
        //发送请求同时获取请求响应
        ResponseEntity<Map> response = restTemplate.exchange("http://localhost:8091/springboot_dev/demo//delete/{id}", HttpMethod.DELETE, null, Map.class,id);
        return Objects.requireNonNull(response.getBody()).toString();
    }
}

3、使用Swagger调用接口

  • Swagger是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。
  • 有以下 3 个重要的作用：
    • 将项目中所有的接口展现在页面上，这样后端就不需要专门为前端编写专门的接口文档；
    • 当接口更新之后，只需要修改代码中的 Swagger 描述就可以实时生成新的接口文档了，从而规避了接口文档老旧不能使用的问题；
    • 通过 Swagger 页面，我们可以直接进行接口调用，降低了项目开发阶段的调试成本。

1、原生Swagger

  • 引入swagger的依赖
	<!--swagger2的依赖：swagger是一系列对REST接口的描述和UI展示的规范-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
  • 编写配置类
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    /*
     *用来告诉springfox怎么去生成swagger所需要的规范数据
     */
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2) //生成swagger2规范的文档
                .useDefaultResponseMessages(false)
                .pathMapping("/") //设置哪些接口的路径会映射到swagger文档上
                .apiInfo(apiInfo()) //设置文档主体信息
                .select() //接口选择器
                .apis(RequestHandlerSelectors.basePackage("com.trs.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 自定义文档主体信息
     * @return
     */
    private ApiInfo apiInfo() {
       return new ApiInfoBuilder()
                .title("SpringBoot整合Swagger")
                .description("SpringBoot整合Swagger的过程")
                .version("1.0")
                .contact(new Contact("开发者","www.baodu.com","12345@qq.com"))
                .build();
    }
}
  • 访问地址：http://localhost:8091//springboot_dev/swagger-ui.html
    原生swagger

2、Knife4j

  • knife4j是Swagger2的增强版，更加友好的操作页面，更多强大的功能，基于Swagger2和 OpenAPI，提供了一个更好的接口文档界面。
  • 引入依赖
 		<dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.9</version>
        </dependency>
  • 定义配置类
@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {
  
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2) //生成swagger2规范的文档
                .useDefaultResponseMessages(false)
                .pathMapping("/") //设置哪些接口的路径会映射到swagger文档上
                .apiInfo(apiInfo()) //设置文档主体信息
                .select() //接口选择器
                .apis(RequestHandlerSelectors.basePackage("com.trs.controller"))
                .paths(PathSelectors.any())
                //描述文档的主体信息
                .build();
    }

    /**
     * 自定义文档主体信息
     * @return
     */
    private ApiInfo apiInfo() {
       return new ApiInfoBuilder()
                .title("SpringBoot整合Swagger")
                .description("SpringBoot整合Swagger的过程")
                .version("1.0")
                .contact(new Contact("开发者","www.baodu.com","12345@qq.com"))
                .build();
    }
}
  • 访问地址：http://localhost:8091//springboot_dev/doc.html
    Knife4j

3、相关注解

1、@Api

  • 作用：修饰类，一般修饰的是Controller类，标识这个类是swagger的资源。
  • 相关属性：
    • tags：类的说明，如果有多个值，会生成多个List；
    • value：类的说明，可以使用tags来替代；
    @RestController
@RequestMapping("/signal")
@Api(tags = {"信号API"},value = "信号API")
public class SignalController {}

2、 @ApiOperation

  • 作用：修饰Controller类中的方法，用于说明一个http请求的操作。
  • 相关属性：
    • value：方法的说明；
    • notes：提示内容；
    • tags：可替代value；

3、@ApiParam

  • 作用：修饰Controller类中方法的参数，用于设置参数说明
  • 相关属性：

    • name：参数名；

    • value：参数说明；

    • required：是否必填，默认为false；

      @RestController
@RequestMapping("/user")
@Api(tags = {"用户API"},value = "用户API")
public class UserController {
    
    @GetMapping("/getUserInfo")
    @ApiOperation(value="获取用户信息",tags={"获取用户信息"},notes="注意参数必须一致")
    public User getUserInfo(
        @ApiParam(name="userId",value="用户Id",required=true)
        Long userId,
        @ApiParam(name="userName",value="用户名称",required=false)
        String userName){
        User user = userService.getUserInfo();
        return user;
    }
}

4、@Apilgnore

  • 作用：修饰类、方法、参数等等，表示不显示在swagger的文档中。

5、@ApilmplicitParam

  • 作用：用于对方法中的单个参数进行说明；
  • 相关属性：
    • name：参数名；
    • value：参数说明；
    • dataType：数据类型；
    • paramType：参数类型；
    • required：是否必须传值;
    • example：举例说明；
    @ApiOperation("查询用户列表")
@GetMapping("/select")
@ApiImplicitParam(name = "name",value = "用户名",dataType="String",paramType = "query",required = true,example = "张三")
public void queryList(String name){}

6、@ApiImplicitParams

  • 作用：用于对方法中的多个参数进行说明，包含了多个@ApiImplicitParam。
    @ApiOperation("查询用户列表")
    @GetMapping("/select")
    @ApiImplicitParams({
            @ApiImplicitParam(name="name",value="用户名",dataType="string", paramType = "query",example="xingguo"),
            @ApiImplicitParam(name="id",value="用户id",dataType="long", paramType = "query")
    })
    public void queryList(Long id, String name){}

7、@ApiResponses 与 @ApiResponse

  • 作用：对响应结果进行说明；
     @GetMapping("/getAiResult")
 @ApiOperation("信息软删除")
 @ApiResponses({ @ApiResponse(code = 200, message = "操作成功"),
            @ApiResponse(code = 500, message = "服务器内部异常"),
            @ApiResponse(code = 405, message = "权限不足") })
    public RtnResult remove(Long id) {}

8、@ApiModel

  • 作用：修饰对象类，并对对象类进行说明，用于Model实体类接收参数的场景。
  • 相关属性：
    • value：设置对象名称；
    • description：对对象类进行具体描述；

9、@ApiModelProperty

  • 作用：修饰对象类中的属性，并对属性进行说明；
  • 相关属性：
    • value：字段说明；
    • name：字段名称；
    • dataType：数据类型；
    • required：是否必填，默认false；
    • example：举例说明；
    • hidden：是否隐藏；
@ApiModel(value = "司法信号实体",description="司法信号对象")
public class JusticeSiganlModel implements Serializable {
    @ApiModelProperty(name = "eid",value ="企业Id",example = "qa64b0ed4b4093")
    private String eid;
    @ApiModelProperty(name = "entName",value = "企业名称",required = "true",hidden="true")
    private String entName;
}
XQ_898878888
关注
  • 26
    点赞
  • 踩
  • 28
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
第4章 SpringBoot与Web应用
天空鸟的博客
12-02 2019
在本书所讲解的文件上传处理过程中，都是将图片保存到本地的Web服务端，但是从实际的开发来讲，这种操作是不可行的。本程序在发生异常之后采用跳转的形式来处理，而SpringBoot最大的特点是支持Restful处理，因此为了描述异常，也可以直接采用Restful的形式回应异常信息，即不再跳转到HTML页面进行显示。在进行Web开发过程中，用户提交数据的合法性是最基础的验证手段，在SpringBoot中可以直接使用hibernate-vidator组件包实现验证处理，而此组件包中支持的验证注解如表4-1所示。
02. SpringBoot整合Web开发
03-20
SpringBoot整合Web开发是现代Java应用开发中的常见实践，它极大地简化了配置和启动过程，使得开发者能够快速构建可部署的Web服务。本教程将深入探讨如何利用SpringBoot与Web技术进行集成，创建高效且易于维护的应用...
springboot-web开发
weixin_51604685的博客
08-09 3225
这是springboot关于web开发的知识，springboot的web开发和springmvc很相似
SpringBoot的web开发
ITSM/ITIL/网络安全/IT运维
04-24 1884
简介 Web开发的核心内容主要包括内嵌的Servlet容器和SpringMVC。 SpringBoot使用起来非常简洁，大部分配置都有SpringBoot自动装配。 SpringBoot的web支持 SpringBoot提供了spring-boot-starter-web为web开发予以支持，而这个启动器内嵌了Tomcat以及SpringMVC依赖。而web相关的自动配置存储在spring-boot-autoconfigure.jar的org.springframework.boot.autoco...
SpringBoot与Web开发（超详细）【篇一】
2401_84097820的博客
05-13 669
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。因此收集整理了一份《2024年Web前端开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！
详细SpringBoot教程之Web开发（一）
热门推荐
BoCong-Deng的博客
02-24 2万+
写在前面 鉴于有人留言说想要学习SpringBoot相关的知识，我这里打算写一个SpringBoot系列的相关博文，目标呢是想让看了这一系列博文的同学呢，能够对SpringBoot略窥门径，这一系列的博文初步都定下来包括SpringBoot介绍、入门、配置、日志相关、web开发、数据访问、结合docker、缓存、消息队列、检索、任务安全、分布式等等一系列的博文，工作量很大，是个漫长的过程，每一步我...
Springboot 开发 Web Flux
tonysong111073的专栏
10-02 2840
简单介绍WebFlux
java开发web项目前端_Springboot开发web项目
weixin_33158756的博客
02-13 1468
当前，Spring毫无疑问已经成为java后台对象管理标准框架，除了通过IOC能够管理我们的自定义对象的生命周期之外还提供了众多功能繁复的可配置功能模块。但同时带来了复杂的配置项，这对初学者而言简直是一种灾难。于是SpringBoot应运而生，Springboot的出现大大简化了配置，主要表现在消除了web.xml和依赖注入配置的整合，处处遵循规约大于配置的思想，将初学者在繁杂的配置项中解放出来，...
springboot开发非web应用程序
weixin_43769566的博客
07-15 3526
方式一主程序实现接口CommandLineRunner，然后需要实现一个方法run，主程序里原来的main方法不能丢掉 方式二，更简单些
springboot入门案例，web开发
TxCode的博客
10-24 2400
一.springboot框架入门 1.1Spring Boot 简介 Spring Boot 是 Spring 家族中的一个全新的框架，它用来简化 Spring 应用程序的创建和 开发过程，也可以说 Spring Boot 能简化我们之前采用 SpringMVC + Spring + MyBatis 框架进行 开发的过程。 在以往我们采用 SpringMVC + Spring + MyBatis 框架进行开发的时候，搭建和整合三大框 架，我们需要做很多工...
springboot搭建完整web开发环境
zhiaiasnx的博客
03-16 945
springboot搭建web环境
第5章 SpringBoot实现Web开发.ppt
03-08
SpringBoot实现Web开发
基于springboot的web开发简单笔记
08-20
基于springboot的web开发简单笔记
springboot的web开发.rar
09-05
在本文中，我们将深入探讨如何使用SpringBoot进行Web开发，并结合Redis和RabbitMQ来构建高效、可扩展的应用程序。SpringBoot是Spring框架的一个模块，它简化了初始设置和配置，使得开发人员能够快速地搭建和运行应用...
Springboot开发基于springboot的快速web项目.zip
05-05
Springboot开发基于springboot的快速web项目.zipSpringboot开发基于springboot的快速web项目.zipSpringboot开发基于springboot的快速web项目.zipSpringboot开发基于springboot的快速web项目.zipSpringboot开发基于...
Spring Boot中的多租户架构实现
微赚淘客开发者博客
07-06 1427
在多租户系统中，每个租户都能够安全且有效地使用相同的应用程序，同时确保数据隔离和性能独立性。通过合理的设计和实施，开发人员可以有效地管理和运行支持多个租户的应用程序，从而提升系统的灵活性和扩展性。每个租户是一个逻辑上独立的客户，拥有自己的数据、配置、用户界面等资源，而这些资源又可以在同一个应用程序实例中共享。在Spring Boot中配置多租户数据源，可以使用AbstractRoutingDataSource实现动态数据源切换，根据不同的租户标识动态选择数据源。
项目实战--Spring Boot + GraphQL实现实时数据推送
qq_40623672的博客
07-10 456
GraphQL是一种用于API的查询语言，核心思想是让客户端能够根据自身需求精确地获取所需的数据，而不是像传统的RESTful API那样只能获取整个资源对象。（1）灵活性：客户端可以精确指定所需的数据字段，而不是被限制于服务器端提供的固定数据结构。（2）效率：减少了不必要的数据传输和处理，提高了数据获取效率。（3）类型系统：GraphQL具有严格的类型系统，能够在编译阶段检测出潜在的错误，提高了开发效率。
Spring Boot集成pf4j实现插件开发功能
最新发布
HBLOG
07-10 563
一个插件框架，用于实现插件的动态加载，支持的插件格式（zip、jar）。
Spring Boot单体服务之间用feign调用
木槿
07-09 163
会定义路径和url等信息，用于指定服务调用服务调用启动feign配置调用url。
springbootweb开发
05-21
Spring Boot 是一个快速构建基于 Spring 框架的应用程序的工具。它为 Spring 应用程序开发提供了一种简单的方法，无需繁琐地配置 XML，只需要使用注解即可实现常见的业务逻辑。 下面是一个基本的 Spring Boot Web 应用程序的步骤： 1. 创建一个 Maven 项目，并添加 Spring Boot 的依赖。 2. 创建一个 Controller 类，并添加处理请求的方法。 3. 配置应用程序的入口点，并启动应用程序。 以下是一个简单的示例： 1. 创建 Maven 项目 使用 Maven 创建一个新的项目，可以参考以下命令： ``` mvn archetype:generate -DgroupId=com.example -DartifactId=webapp -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false ``` 2. 添加 Spring Boot 依赖 在 pom.xml 文件中添加 Spring Boot Starter Web 依赖： ``` <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> </dependencies> ``` 3. 创建 Controller 类 创建一个 HomeController 类，并添加处理请求的方法： ``` @RestController public class HomeController { @GetMapping("/") public String home() { return "Hello, World!"; } } ``` 4. 配置应用程序的入口点 创建一个 SpringBootWebApplication 类，并使用 @SpringBootApplication 注解标记为应用程序的入口点： ``` @SpringBootApplication public class SpringBootWebApplication { public static void main(String[] args) { SpringApplication.run(SpringBootWebApplication.class, args); } } ``` 5. 启动应用程序 使用以下命令启动应用程序： ``` mvn spring-boot:run ``` 在浏览器中访问 http://localhost:8080/ ，即可看到 "Hello, World!"。 这就是一个简单的 Spring Boot Web 应用程序的开发过程。当然，除了以上步骤，还有很多其他的配置和实现方式，具体可以参考官方文档。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值