springboot基本项目结构和常用的注解简单使用方法

简介: springboot

1. 项目结构

1.1 结构图

1.2 介绍

  • src
  • main
  • java
  • com.cheng.ai 包名
  • controller 控制层
  • service 服务层
  • mapper dao层
  • entity 实体类文件夹
  • rescources
  • application.yaml
  • templates
  • test 测试文件包

大体可以分为上面这种结构,控制层主要写跟前端交互的代码,服务层主要写业务代码供控制层调用,dao层写操作数据库的代码供服务层调用,实体类主要写数据库表对应的关系模型,将数据库中数据和代码关联供dao层调用

  • 这些文件结构以及关系是

控制层------>服务层------->dao层-------->实体类,一层层调用。

1.3 为什么要这样分

  • 假设我们做一个商城程序
  • 需要查询商品的列表
  • 需要返回一个商品列表的数据

那么按照一个文件写,我把控制层、服务层等写在一个文件里面,这样就可以让项目结构清晰简单了。

但是随之而来的问题,你的这个查询商品列表的业务要是太复杂了,可能整个流程写下来有几百上千行代码了,而且代码依赖性太强了,突然有个地方出了bug你找出来麻烦,就算很简单找出来,但是前面代码一动后面代码万一全跟着错了怎么办,这改下来不得掉一斤头发,万一改好一个又一个怎么办,为了避免这样的事情出现所以分文件写,错了也不会导致这样雪崩式的错误出现。


      但是还有人杠,我写的代码不可能有错的,好!代码没有错,万一要是前端要你把接口改一下呢,数据库表有点细微的变化呢、返回的数据要你改改呢。我知道你没有错,但是这还是得改,总不可能把他们打了说不改吧。所以这样一改,还是会导致各种问题出现。

你以多文件的方式去暴露方法接口,就算你某个层要修改也仅仅只是某个层的代码要改,不会影响其他层的代码,其他层只是调用了方法并不关心内部代码如何,这样使代码大大解耦合,使可用性更高。

2. 常用注解

2.1 程序启动 @SpringBootApplication

@SpringBootApplication// 将此类标记为程序启动类,程序将从此进入启动publicclassAiApplication {
publicstaticvoidmain(String[] args) {
SpringApplication.run(AiApplication.class, args);
    }
}

2.2 配置类 @Configuration

@Configuration// 将此文件标记为配置类,跟随程序启动加载@MapperScan({"com.cheng.ai.mapper"}) // 后面mybatis一起讲publicclassMybatisConfig {
}

2.3@component、@Service、@Controller、@Respository

  • 这几个注解功能基本上一样,用在不同的地方

注解

说明

@Component

普通实体注入spring容器

@Repository

dao层注入spring容器

@Service

服务层注入spring容器

@Controller

控制层注入spring容器

在前后端分离项目中一般使用@RestController代替@Controller,因为@RestController包含了@Controller等注解,以下是他的代码

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented@Controller@ResponseBodypublic@interfaceRestController {
@AliasFor(
annotation=Controller.class    )
Stringvalue() default"";
}

2.4 @ResponseBody

@ResponseBody可以作用在方法上或类上,表示该方法的返回结果直接写入 HTTP response body 中,而不会被解析为跳转路径,即不会经过视图解析器,返回什么数据即在页面输入什么数据。下面是@ResponseBody注解源码

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documentedpublic@interfaceResponseBody {
}

2.5 @Autowired

此注解会自动在spring容器中找到bean进行自动装配,如果发现找到多个bean,则按照name方式比对,如果还有多个,则报出异常

@Service// 在实现类注入publicclassAiLogServiceImplextendsServiceImpl<AiLogMapper, AiLog>implementsAiLogService {
}
@RestController@RequestMapping("/aiLog")
publicclassAiLogController {
@AutowiredprivateAiLogServiceaiLogService; // 装配@GetMapping("test")
publicCommonResultgetlist(){
List<AiLog>list=aiLogService.list();
returnCommonResult.success(list);
    }
}

2.6 @RequestMapping、@GetMapping、@PostMapping......

这些注解定义请求的url,@RequestMapping可以用在类上或者方法上

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented@Mappingpublic@interfaceRequestMapping {
    ......
}
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented@RequestMapping(
method= {RequestMethod.POST}
)
public@interfacePostMapping{
    ......
}

可以看到PostMapping仅仅只是RequestMapping限定methon(请求方法的注解),并且只可以用于方法上,PostMapping限定的请求只能以POST方式,GetMapping限定GET方式请求,其他XXXMapping就是限定XXX请求方式

2.7 @Value

可以注入在配置文件中的值到实体类,注意此类要加入到sping容器此注解才有效

2.8 @Bean

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documentedpublic@interfaceBean {
    ......
}

作用于方法上,将方法的返回值注入到spring容器中

@Configuration@EnableSwagger2WebMvcpublicclassSwaggerConfig {
// 创建Docket存入容器,Docket代表一个接口文档@BeanpublicDocketwebApiConfig(){
returnnewDocket(DocumentationType.SWAGGER_2)
// 创建接口文档的具体信息                .apiInfo(webApiInfo())
// 创建选择器,控制哪些接口被加入文档                .select()
// 指定@ApiOperation标注的接口被加入文档                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .build();
    }
}

2.9@RequestParam@RequestBody@PathVariable@RequestHeader、@CookieValue

这些注解用来接收前端参数的

@ResquestParam

get请求获取参数的注解

@PathVariable

获取路径参数

@ResquestHeader

获取请求头的信息

@CookieValue

获取Cookie的信息

示例:

@GetMapping("/list/{pageNum}/{pageSize}")
publicCommonResult<List<Brand>>getList(@PathVariable("pageNum") intpageNum,
@PathVariable("pageSize") intpageSize){
        ......
    }


相关文章
|
6月前
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
1003 128
|
6月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
679 0
|
5月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
639 2
|
6月前
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
795 1
使用Spring的@Retryable注解进行自动重试
|
6月前
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
458 12
|
6月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
349 0
探索Spring Boot的@Conditional注解的上下文配置
|
6月前
|
智能设计 Java 测试技术
Spring中最大化@Lazy注解,实现资源高效利用
本文深入探讨了 Spring 框架中的 `@Lazy` 注解,介绍了其在资源管理和性能优化中的作用。通过延迟初始化 Bean,`@Lazy` 可显著提升应用启动速度,合理利用系统资源,并增强对 Bean 生命周期的控制。文章还分析了 `@Lazy` 的工作机制、使用场景、最佳实践以及常见陷阱与解决方案,帮助开发者更高效地构建可扩展、高性能的 Spring 应用程序。
269 0
Spring中最大化@Lazy注解,实现资源高效利用
|
6月前
|
安全 IDE Java
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
本文介绍了如何在 Spring 应用程序中使用 Project Lombok 的 `@Data` 和 `@FieldDefaults` 注解来减少样板代码,提升代码可读性和可维护性,并探讨了其适用场景与限制。
233 0
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
|
6月前
|
Java 测试技术 编译器
@GrpcService使用注解在 Spring Boot 中开始使用 gRPC
本文介绍了如何在Spring Boot应用中集成gRPC框架,使用`@GrpcService`注解实现高效、可扩展的服务间通信。内容涵盖gRPC与Protocol Buffers的原理、环境配置、服务定义与实现、测试方法等,帮助开发者快速构建高性能的微服务系统。
1302 0
|
6月前
|
XML Java 测试技术
使用 Spring 的 @Import 和 @ImportResource 注解构建模块化应用程序
本文介绍了Spring框架中的两个重要注解`@Import`和`@ImportResource`,它们在模块化开发中起着关键作用。文章详细分析了这两个注解的功能、使用场景及最佳实践,帮助开发者构建更清晰、可维护和可扩展的Java应用程序。
329 0

热门文章

最新文章