SpringBoot最佳实践

骑猪看日落 2024-03-23 20:52 80阅读 0赞

#### 文章目录 ####

*  1 SpringBoot集成PageHelper
 *   *  1.1 导入依赖
     *  1.2 配置PageHelper
     *  1.3 使用PageHelper
 *  2 SpringBoot集成MybatisPlus
 *   *  2.1 导入依赖
     *  2.2 配置MybatisPlus
     *  2.3 使用MybatisPlus
 *  3 SpringBoot集成Redis
 *   *  3.1 导入依赖
     *  3.2 配置Redis
     *  3.3 使用Redis
 *  4 SpringBoot解决跨域
 *   *  4.1 局部解决跨域
     *  4.2 全局解决跨域

## 1 SpringBoot集成PageHelper ##

PageHelper是Mybatis的分页插件，简单易用。

### 1.1 导入依赖 ###

如果已经导入了mybatis-plus依赖，请排除mybatis和mybatis-spring依赖，避免mybatis的版本冲突。

<dependency>
                <groupId>com.github.pagehelper</groupId>
                <artifactId>pagehelper-spring-boot-starter</artifactId>
                <version>1.4.6</version>
                <exclusions>
                    <exclusion>
                        <groupId>org.mybatis</groupId>
                        <artifactId>mybatis</artifactId>
                    </exclusion>
                    <exclusion>
                        <groupId>org.mybatis</groupId>
                        <artifactId>mybatis-spring</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>

### 1.2 配置PageHelper ###

在`application.yml`中配置相关分页设置

pagehelper:
      reasonable: true
      support-methods-arguments: true

### 1.3 使用PageHelper ###

只需要在需要分页的操作前开启分页即可

PageHelper.startPage(pageNo, pageSize);
            List<User> users = userMapper.selectList(null);

如果需要分页信息，可以使用PageInfo去接收数据，将PageInfo返回

PageHelper.startPage(pageNo, pageSize);
            List<User> users = userMapper.selectList(null);
            PageInfo<User> pageInfo = new PageInfo<>(users);
            return pageInfo;

![在这里插入图片描述][2c7ca6c2e4c840a294fa8732c72e5d61.png]

## 2 SpringBoot集成MybatisPlus ##

MybatisPlus只是对Mybatis进行增强，不做任何修改。

### 2.1 导入依赖 ###

(1) 在此之前需要导入mysql驱动

<dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.28</version>
            </dependency>

(2) 导入mybatis-plus场景启动器

<dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.5.3</version>
            </dependency>

### 2.2 配置MybatisPlus ###

(1) 配置数据库的连接信息，配置mapper映射文件的位置、配置包的别名和开启SQL打印

# 数据源
    spring:
      datasource:
        url: jdbc:mysql://localhost:3306/test1?serverTimeZone=Asia/Shanghai
        username: root
        password: root
        driver-class-name: com.mysql.cj.jdbc.Driver
    # mybatis-plus    
    mybatis-plus:
      mapper-locations: classpath:mapper/*.xml
      type-aliases-package: com.jixian.boot3.entity
      configuration:
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

(2) 配置mapper接口的位置  
在主启动类上启用mapper接口的扫描

@SpringBootApplication
    @MapperScan("com.jixian.boot3.mapper")
    public class Boot3DemoApplication {
        
        public static void main(String[] args) {
        
            SpringApplication.run(Boot3DemoApplication.class, args);
        }
    }

### 2.3 使用MybatisPlus ###

(1) `DAO`层的mapper接口继承BaseMapper，可以使用基础的CRUD

public interface UserMapper extends BaseMapper<User> {
        
    }

(2) Service实现类继承ServiceImpl，Service接口继承IService接口，可以使用`Service`层的CRUD。  
Service接口继承IService

public interface UserService extends IService<User> {
        
        
    }

Service实现类继承ServiceImpl  
一旦继承了ServiceImpl了，UserMapper会被自动注入进来  
![在这里插入图片描述][8cdc6e4f52954878be12130341bdaed4.png]

@Service
    public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService  {
        
    
    }

(3) 在`Controller`层使用  
使用mybatis-plus自带的CRUD

@RestController
    public class UserController {
        
        @Autowired
        private UserService userService;
        @GetMapping("/user")
        public List<User> list(){
        
            return userService.list();
        }
    }

![在这里插入图片描述][6addf629a84247cb86364e7f476956ea.png]

## 3 SpringBoot集成Redis ##

### 3.1 导入依赖 ###

(1) 添加redis场景启动器

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

(2) 使用redis连接池

<dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-pool2</artifactId>
            </dependency>

### 3.2 配置Redis ###

(1) 配置redis的连接信息和连接池的参数

spring:
      redis:
        # 地址
        host: 192.168.231.10
        # 端口，默认为6379
        port: 6379
        # 数据库索引
        database: 0
        # 密码
        password: 123456
        # 连接超时时间
        timeout: 10s
        lettuce:
          pool:
            # 连接池中的最小空闲连接
            min-idle: 0
            # 连接池中的最大空闲连接
            max-idle: 8
            # 连接池的最大数据库连接数
            max-active: 8
            # #连接池最大阻塞等待时间（使用负值表示没有限制）
            max-wait: -1ms

(2) 配置Redis序列化  
Redis默认序列化是JDK的序列化，为了方便调试程序，需要自定义序列化。

@SpringBootConfiguration
    public class RedisConfig {
        
    
        @Bean
        public  RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory)
                throws UnknownHostException {
        
            RedisTemplate<String, Object> template = new RedisTemplate<>();
            template.setConnectionFactory(redisConnectionFactory);
    
            // string的序列化
            template.setKeySerializer(RedisSerializer.string());
            template.setValueSerializer(valueSerializer());
            // hash的序列化
            template.setHashKeySerializer(RedisSerializer.string());
            template.setHashValueSerializer(valueSerializer());
    
            template.afterPropertiesSet();
    
            return template;
        }
        
        private RedisSerializer valueSerializer(){
        
            //使用Jackson2JsonRedisSerializer来序列化和反序列化redis的value值（默认使用JDK的序列化方式）
            Jackson2JsonRedisSerializer jacksonSeial = new Jackson2JsonRedisSerializer(Object.class);
    
            ObjectMapper om = new ObjectMapper();
            // 指定要序列化的域，field,get和set,以及修饰符范围，ANY是都有包括private和public
            om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
            // 指定序列化输入的类型，类必须是非final修饰的，final修饰的类，比如String,Integer等会跑出异常
            om.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.WRAPPER_ARRAY);
            jacksonSeial.setObjectMapper(om);
            return jacksonSeial;
        }
    }

### 3.3 使用Redis ###

使用`redisTemplate`来操作Redis

@RestController
    public class UserController {
        
        @Autowired
        private UserService userService;
        @Autowired
        private RedisTemplate redisTemplate;
        @GetMapping("/user")
        public List<User> list(){
        
            List<User> list = userService.list();
            redisTemplate.opsForValue().set("list", list);
            return list;
        }
        @GetMapping("/addKey")
        public void setKey(){
        
            redisTemplate.opsForValue().set("k1", "v1");
        }
    }

![在这里插入图片描述][c3a3c0b850444d8485f60eb0baca23ee.png]

## 4 SpringBoot解决跨域 ##

### 4.1 局部解决跨域 ###

通过`@CrossOrigin`注解配置origins，实现单个Controller的跨域。

@CrossOrigin(origins = "*")
    @RestController
    public class LoginController {
        
        @Autowired
        private UserService userService;
        @PostMapping("/login")
        public R login(@RequestBody LoginBody loginBody){
        
            String token = userService.login(loginBody);
            return R.success().put("token", token);
        }
    }

### 4.2 全局解决跨域 ###

配置Spring框架自带的CorsFilter解决跨域

@SpringBootConfiguration
    public class CorsConfig {
        
        @Bean
        public CorsFilter corsFilter()
        {
        
            CorsConfiguration config = new CorsConfiguration();
            config.setAllowCredentials(true);
            // 设置访问源地址
            config.addAllowedOriginPattern("*");
            // 设置访问源请求头
            config.addAllowedHeader("*");
            // 设置访问源请求方法
            config.addAllowedMethod("*");
            // 有效期 1800秒
            config.setMaxAge(1800L);
            // 添加映射路径，拦截一切请求
            UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
            source.registerCorsConfiguration("/**", config);
            // 返回新的CorsFilter
            return new CorsFilter(source);
        }
    }

[2c7ca6c2e4c840a294fa8732c72e5d61.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/09bae1991dcb4df29412329134f55785.png
[8cdc6e4f52954878be12130341bdaed4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/67af6f5472fb43ffbc7ec3d3350af644.png
[6addf629a84247cb86364e7f476956ea.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/26241038b4f6485ca097246c6fb8b9e5.png
[c3a3c0b850444d8485f60eb0baca23ee.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/1e906d3298204f2fada21b163c0a407a.png