SpringBoot注解把配置文件自动映射到属性和实体类实战

SpringBoot注解把配置文件自动映射到属性和实体类实战

简介：讲解使用@value注解配置文件自动映射到属性和实体类

1、配置文件加载

方式一

1、Controller上面配置

   @PropertySource({"classpath:resource.properties"})

2、增加属性

@Value("${test.name}")

private String name;

　　　　文件上传修改示例：

　　　　FileController.java：

　　　　

package net.xdclass.demo.controller;

import java.io.File;
import java.io.IOException;
import java.util.UUID;

import javax.servlet.http.HttpServletRequest;

import net.xdclass.demo.domain.JsonData;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.multipart.MultipartFile;

/**
 * 功能描述：文件测试
 *
 * <p> 创建时间：Apr 22, 2018 11:22:29 PM </p> 
 */
@Controller
@PropertySource({"classpath:application.properties"})
public class FileController {

    @RequestMapping(value = "/api/v1/gopage")
    public Object index() {
        return "index";
    }

    //private static final String filePath = "L:/Workspaces/Eclipse_Neon/txkt/SpringBootClass/xdclass_springboot/src/main/resources/static/images/";//末尾需要加/，这样才能写进来
    //private static final String filePath = "L:/images/";//末尾需要加/，这样才能写进来
    
    @Value("${web.file.path}")
    private String filePath;

    @RequestMapping(value = "upload")
    @ResponseBody
    public JsonData upload(@RequestParam("head_img") MultipartFile file, HttpServletRequest request) {

        // file.isEmpty(); 判断图片是否为空
        // file.getSize(); 图片大小进行判断

        System.out.println("配置注入打印，文件路径为：" + filePath);
        
        String name = request.getParameter("name");
        System.out.println("用户名：" + name);

        // 获取文件名
        String fileName = file.getOriginalFilename();
        System.out.println("上传的文件名为：" + fileName);

        // 获取文件的后缀名,比如图片的jpeg,png
        String suffixName = fileName.substring(fileName.lastIndexOf("."));
        System.out.println("上传的后缀名为：" + suffixName);

        // 文件上传后的路径
        fileName = UUID.randomUUID() + suffixName;
        System.out.println("转换后的名称:" + fileName);

        File dest = new File(filePath + fileName);

        try {
            file.transferTo(dest);

            return new JsonData(0, fileName);
        } catch (IllegalStateException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return new JsonData(-1, "fail to save ", null);
    }

}

　　　　application.properties：

web.images-path=L:/images
spring.resources.static-locations = classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/,classpath:/test/,file:${web.upload-path}
#指定某些文件不进行监听，即不会进行热加载devtool（重启后不会监听下面这个文件）
#spring.devtools.restart.exclude=application.properties

#通过触发器，去控制什么时候进行热加载部署新的文件
spring.devtools.restart.trigger-file=trigger.txt

server.port=8083

#文件上传路径配置
web.file.path=L:/images

#测试配置文件注入
test.name=www.xdclass.net
test.domain=springboot

　　　　控制台结果：

　　　　　　配置注入打印，文件路径为：L:/images

　　　　　　用户名：123

　　　　　　上传的文件名为：hongmi6.jpg

　　　　　　上传的后缀名为：.jpg

　　　　　　转换后的名称:ee4b60bd-35b4-4df6-bee6-ed62dd5e4a00.jpg

　　　　浏览器返回值：

　　　　{"code":0,"data":"ee4b60bd-35b4-4df6-bee6-ed62dd5e4a00.jpg","msg":null}

　　　　方式二：实体类配置文件
步骤：

1、添加 @Component 注解；

2、使用 @PropertySource 注解指定配置文件位置；

3、使用 @ConfigurationProperties 注解，设置相关属性；

4、必须 通过注入IOC对象Resource 进来 ， 才能在类中使用获取的配置文件值。

@Autowired

    private ServerSettings serverSettings;

    例子：

    @Configuration

@ConfigurationProperties(prefix="test")

@PropertySource(value="classpath:resource.properties")

public class ServerConstant {

　　　　　　  代码示例：

　　　　　　  ServerSettings.java：

package net.xdclass.demo.domain;

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

//服务器配置
@Component
@PropertySource({"classpath:application.properties"})
//@ConfigurationProperties
//自动加入前缀，无需写入test.
@ConfigurationProperties(prefix="test")
//若不想使用prefix="test"，前提是该类中定义的名称要与application.properties中定义的名称一致，即一一对应
public class ServerSettings {

    //名称
    //使用prefix="test"后，无需再使用Value注解
    //@Value("${name}")
    private String name;
    
    //域名地址
    //@Value("${domain}")
    private String domain;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDomain() {
        return domain;
    }

    public void setDomain(String domain) {
        this.domain = domain;
    } 
    
    
}

　　　　　　application.properties同上一个示例

　　　　　　GetController.java部分代码：

    @Autowired
    private ServerSettings serverSettings;
    @GetMapping("/v1/test_properties")
    public Object testProperties(){
        return serverSettings;    
    }

　　　　浏览器测试：

　　　　地址栏输入：http://localhost:8083/v1/test_properties

　　　　结果：{"name":"www.xdclass.net","domain":"springboot"}

常见问题：

1、配置文件注入失败，Could not resolve placeholder

解决：根据springboot启动流程，会有自动扫描包没有扫描到相关注解, 

默认Spring框架实现会从声明@ComponentScan所在的类的package进行扫描，来自动注入，

因此启动类最好放在根路径下面，或者指定扫描包范围

spring-boot扫描启动类对应的目录和子目录

2、注入bean的方式，属性名称和配置文件里面的key一一对应，就不用加@Value 这个注解

如果不一样，就要加@value("${XXX}")　

3、SpringBoot注解把配置文件自动映射到属性和实体类实战简介：讲解使用@value注解配置文件自动映射到属性和实体类1、配置文件加载方式一1、Controller上面配置   @PropertySource({"classpath:resource.properties"})2、增加属性 @Value("${test.name}") private String name;
方式二：实体类配置文件步骤：1、添加 @Component 注解；2、使用 @PropertySource 注解指定配置文件位置；3、使用 @ConfigurationProperties 注解，设置相关属性；
4、必须 通过注入IOC对象Resource 进来 ， 才能在类中使用获取的配置文件值。@Autowired    private ServerSettings serverSettings;
    例子：    @Configuration@ConfigurationProperties(prefix="test")@PropertySource(value="classpath:resource.properties")public class ServerConstant {

常见问题：1、配置文件注入失败，Could not resolve placeholder解决：根据springboot启动流程，会有自动扫描包没有扫描到相关注解, 默认Spring框架实现会从声明@ComponentScan所在的类的package进行扫描，来自动注入，因此启动类最好放在根路径下面，或者指定扫描包范围spring-boot扫描启动类对应的目录和子目录2、注入bean的方式，属性名称和配置文件里面的key一一对应，就用加@Value 这个注解如果不一样，就要加@value("${XXX}")