优秀的编程知识分享平台

网站首页 > 技术文章 正文

两小时入门SpringBoot学习(基础)(上)

nanyue 2024-12-25 14:42:44 技术文章 4 ℃

在学习Springboot之前,你最好具备以下知识:1、使用Maven构建项目;2、熟悉Spring注解;3、了解RESTful API相关知识。需要说明的是你可以不会SpringMVC,但是需要注意Maven版本和Java版本保持一致等问题。

首先请确保你的电脑上安装了java1.8和Maven 3.5及以上,可以使用以下命令进行查看:

java -version
mvn -version

第一个springboot程序

第一步,使用spring Initializr新建一个项目ispringboot,具体操作如下(按照图中序号依次进行即可):





当然如果说你不是idea,那么你可以点击 这里,然后按照图示填写信息:


最后稍等一会,页面就会弹出下载文件,你只需要将其保存到本地即可:


然后删除图中蓝色的4个文件,这些目前使用不到的:


注意为保证本项目能正常运行,请将springboot的版本修改为2.1.3版,切记切记。

启动项目

为了保证启动项目能看到一些信息,在com.envy.luckymoney包内新建一个controller包,里面新建一个HelloController类,里面的代码为:

package com.envy.luckymoney.controller;

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

@RestController
public class HelloController {

    //@RequestMapping(value = "/hello",method = RequestMethod.GET)  //1.x版本
    @GetMapping("/hello")
    public String say(){
        return "First SpringBoot!";
    }
}

然后启动项目,注意项目的启动方式有三种:第一种,最简单的方式:


第二种:在项目根路径下执行maven命令: mvn spring-boot:run,如图所示:


请注意是:mvn spring-boot:run,而不是: mvn springboot:run,中间必须有一个-号,否则就会出现No plugin found for prefix 'spring-boot' ...的问题。

第三种:先在项目根路径(也就是pom.xml所在目录)下执行maven命令mvn install,接着进入到target目录,然后在target目录下执行java -jar luckymoney-0.0.1-SNAPSHOT.jar即可(注意这种方式是springboot项目脱机后运行的方式)


三种方式都成功运行项目后,在浏览器地址栏输入http://localhost:8080/hello,即可看到信息:First SpringBoot!。

配置文件

前面的项目默认启动的是8080端口,现在想使用其他端口。又或者说现在不明确是哪个项目在运行,需要在url中多加一层项目名字,这时应该如何配置呢?很简单找到resources 的application.properties文件,这个就是配置文件,在里面进行设置即可。

server.port=8081
server.servlet.context-path=/luckymoney

启动项目,在浏览器地址栏输入http://localhost:8081/luckymoney/hello,即可看到信息:First SpringBoot!。

当然这样配置是可以的,但是看到配置文件前面的server是相同的,可不可以省略一下呢?当然可以使用yaml就可以解决。在application.properties同级目录下创建一个application.yml文件,里面的代码为:

server:
  port: 8081
  servlet:
    context-path: /luckymoney

启动项目,在浏览器地址栏输入http://localhost:8081/luckymoney/hello,同样可以看到信息:First SpringBoot!。既然都可以的话,优先使用后者,因为它层次感很强,一眼就能看到目录关系。需要注意的是YAML格式语法:key:(空格)value,一定不能忘记空格,否则会出问题。

在实际项目开发中,我们通常希望可以自定义一些信息,而这些信息最好可以放在某个文件中,然后通过某种方式就能读取,Springboot支持将项目的自定义信息放在配置文件中。在application.yml文件中新增以下配置:

#个人信息配置项
info:
  name: envy
  sex: male
  address: beijing

然后希望在HelloController文件中,通过注解给属性赋值的方式来获取配置文件的值并赋值给属性:

package com.envy.luckymoney.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.*;

@RestController
public class HelloController {
    @Value("${info.name}")
    private String name;
    @Value("${info.sex}")
    private String sex;
    @Value("${info.address}")
    private String address;

    @GetMapping("/hello")
    public String say(){
        return String.format("name:%s,sex:%s,address:%s",
                name,sex,address) ;
    }
}

启动项目,在浏览器地址栏输入http://localhost:8081/luckymoney/hello,同样可以看到信息:name:envy,sex:male,address:beijing。

现在更复杂一些,需要在配置中使用配置,此时可以使用${}形式:

#个人信息配置项
info:
  name: envy
  sex: male
  address: beijing
  description: hey,i am come from ${info.address},and name is ${info.name}.

那么此时在HelloController文件中的代码就需要修改为:

package com.envy.luckymoney.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.*;

@RestController
public class HelloController {
    @Value("${info.name}")
    private String name;
    @Value("${info.sex}")
    private String sex;
    @Value("${info.address}")
    private String address;
    @Value("${info.description}")
    private String description;

    @GetMapping("/hello")
    public String say(){
        return String.format("name:%s,sex:%s,address:%s,description:%s",
                name,sex,address,description) ;
    }
}

启动项目,在浏览器地址栏输入http://localhost:8081/luckymoney/hello,同样可以看到信息:name:envy,sex:male,address:beijing,description:hey,i am come from beijing,and name is envy.。

现在问题来了,这才仅仅是4个配置信息,每一个配置信息前都需要使用@Value("${info.name}")这种形式,实际上配置信息有很多,甚至几百种,那时候怎么办?此时观察配置文件发现,目前关于个人的配置信息都在info这个层级下面,那么我们是不是可以理解为info就是一个对象,而第二层级的信息可以看做是它的属性?

在HelloController类的同级目录下新建一个InfoConfig类,里面用于定义哪些属性,及getter和setter、toString方法:

package com.envy.luckymoney.controller;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "info")
public class InfoConfig {
    private String name;
    private String address;
    private String sex;
    private String description;
   //getter和setter、toString方法
}

注意在这个类中需要使用@ConfigurationProperties注解,用于把配置信息自动封装成实体类,然后配置里面的前缀prefix,也就是配置文件的第一层info,这个要注意。当然仅仅这样是不够的,因为后面我们是在controller中调用这个bean,那么应当使用@Component注解来让IOC容器管理Bean。那么在HelloController类中的代码应当修改为:

package com.envy.luckymoney.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
public class HelloController {

    @Autowired
    private InfoConfig infoConfig;

    @GetMapping("/hello")
    public String say(){
        return infoConfig.toString();
    }
}

启动项目,在浏览器地址栏输入http://localhost:8081/luckymoney/hello,同样可以看到信息:InfoConfig{name='envy', address='beijing', sex='male', description='hey,i am come from beijing,and name is envy.'}。

那么什么时候使用单个配置,什么时候使用实体类呢?这个就需要看自己的业务了。

多环境配置

接下来谈谈运行环境,一般而言有开发、生产和测试这三种环境,这些环境中的一些参数值肯定是不一样的,那么我们需要在某种环境下再修改配置文件吗?当然不是了,springboot提供了多环境配置。在resources目录下新建两个文件:application-dev.yml和application-prd.yml,内容就直接复制application.yml的即可:(注意名称其实可以随意,只要符合application-{}.yml形式即可)

application-dev.yml中的代码为:

#个人信息配置项
info:
  name: dev
  sex: male
  address: beijing
  description: hey,i am come from ${info.address},and name is ${info.name}.

application-prd.yml中的代码为:

#个人信息配置项
info:
  name: prd
  sex: male
  address: beijing
  description: hey,i am come from ${info.address},and name is ${info.name}.

当你需要指定使用哪个环境的时候,只需要在application.yml中进行配置即可:

spring:
  profiles:
    active: dev

只需要这样修改是不是非常简单。

SpringBoot打包与运行

springboot打包方式很简单,直接在项目目录(pom.xml所在同级目录),执行mvn package,接着在生成的target目录下,找到luckymoney-0.0.1-SNAPSHOT.jar文件,这个就是打包生成的jar包,为什么是jar包而不是war包呢?因为war包需要在tomcat容器内才能运行,也就意味着你本机还需要安装tomcat并启动它,但是jar不需要,因为它是标准的java包,可以使用java -jar 项目名称这种方式和就能启动项目。

现在你可能需要问,假如我某一个项目当时打包用了dev环境,现在我想运行在prd环境,那应该怎样操作呢?有人说这是一个jar包可以解压后,通过修改主配置文件方式啊,这种方式似乎是可行的,但是假设某个人电脑上此时没有安装可以解压jar包的软件呢?这时候不就没办法了吗?

其实SpringBoot早就想到这个问题了,你只需要将三个配置文件:application.yml、application-dev.yml和application-prd.yml放在之前打包成的jar的文件夹内即可(注意它们四个必须在同一个文件夹中),然后通过修改这三个配置文件,jar包会优先读取外面三个yml文件的相关配置。

如果你觉得上面那种方式还是不行,那你可以在项目启动的时候指定运行环境,使用的命令为:java -jar Dspring.profiles.active=prd 项目名称,还有其实后面可以直接使用项目绝对路径启动的java -jar Dspring.profiles.active=prd F:\Springboot\Test\luckymoney\target\luckymoney-0.0.1-SNAPSHOT.jar这种方式来启动。

Controller的使用

先来看三个注解的使用:@Controller和在SpringMVC中的用法没什么大的变化,用于处理http请求;@RestController这个注解是Spring4之后新增的,用于替代原来返回json数据需要使用@Controller和@ResponseBody这两个注解;@RequestMapping在方法上使用,用于配置url映射。(前面说过是在springboot1.x版本中使用,但是在一些特殊项目中还是需要使用这个)

前面都是直接返回json对象,接下来介绍如何返回html信息。首先明确既然需要返回html信息,因此不能使用@RestController注解,同时有必要说明一下
@ResponseBody注解的作用,@ResponseBody注解的作用是将controller中方法返回的对象通过适当的转换器转换为指定的格式之后,写入到response对象的body区,通常用来返回JSON数据或者是XML。所以需要将HelloController类中的@RestController修改为@Controller,但是你仅仅这样是不行的,因为你返回的对象无法通过视图解析器进行解析,因此还需要引入模板解析引擎thymeleaf(读做[taim li:f] ,也就是百里香的意思)。

第一步,在pom.xml文件中新增thymeleaf依赖:

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

第二步,在templates文件夹中新建index.html文件,里面的代码为:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>首页</title>
</head>
<body>
<h1>welcome to learn springboot!</h1>
</body>
</html>

第三步,使用thymeleaf模板,修改HelloController.java中的代码为:

package com.envy.luckymoney.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@Controller
public class HelloController {

    @Autowired
    private InfoConfig infoConfig;

    @GetMapping("/hello")
    public String say(){
        return "index";
    }
}

启动项目,在浏览器地址栏输入http://localhost:8081/luckymoney/hello,可以看到信息:welcome to learn springboot!。这种模板渲染用的比较少,大部分都是前后端分离的模式。注释掉刚才增加的依赖和代码,我们继续回到之前的内容。

注意@ResponseBody注解的位置,如果你希望某个controller中的所有方法都是返回json,那么可以直接在controller类上使用@ResponseBody,如果其中某个方法需要返回内容,那么就建议只在某个需要返回json数据的方法上使用@ResponseBody注解。


最近发表
标签列表