实战spring自定义属性(schema)：快速体验

最新推荐文章于 2024-01-06 23:15:02 发布
最新推荐文章于 2024-01-06 23:15:02 发布
阅读量3.2k 收藏 2
点赞数 4
分类专栏： java服务端 文章标签： spring schema java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/boling_cavalry/article/details/74066494
版权

在开发dubbo服务的时候，我们会在xml中做以下类似的配置：

<dubbo:application name="dubbo_service_provider" />
<dubbo:registry address="zookeeper://127.0.0.1:2181" />
<dubbo:protocol name="dubbo" port="20880" />

spring启动后，dubbo的本地运行时环境就会获取到这些信息，根据这些信息完成注册服务，今天我们实战的内容就是开发一个类似的自定义属性，然后在spring项目中使用这个属性；

整个实战过程分为以下几步：

  1. 创建web工程；
  2. 创建配置属性的bean；
  3. 创建XSD文件；
  4. 创建自定义BeanDefinitionParser，制定配置信息的解析规则；
  5. 创建自定义NamespaceHandler，规定配置信息的解析器；
  6. 添加spring.handlers文件;
  7. 添加spring.schemas文件;
  8. 在工程中配置一个这样的属性；
  9. 启动web工程，验证配置；

本次实战对应的源码可以从我的git上下载，地址是：git@github.com:zq2599/blog_demos.git，里面有多个工程，本次用到的是springschemademo，如下图红框所示：
这里写图片描述
开始实战吧：

创建web工程

创建一个maven工程，pom.xml的内容如下，主要是把spring相关的依赖引入：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.bolingcavalry</groupId>
  <artifactId>springschemademo</artifactId>
  <packaging>war</packaging>
  <version>0.0.1-SNAPSHOT</version>
  <name>app Maven Webapp</name>
  <url>http://maven.apache.org</url>
  <properties>
    <!-- spring版本号 -->
    <spring.version>4.0.2.RELEASE</spring.version>
  </properties>
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <!-- 表示开发的时候引入，发布的时候不会加载此包 -->
      <scope>test</scope>
    </dependency>
    <!-- spring核心包 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-oxm</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-tx</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-jdbc</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-aop</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context-support</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-test</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-beans</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <!-- 导入java ee jar 包 -->
    <dependency>
      <groupId>javax</groupId>
      <artifactId>javaee-api</artifactId>
      <version>7.0</version>
    </dependency>
    <!-- JSTL标签类 -->
    <dependency>
      <groupId>jstl</groupId>
      <artifactId>jstl</artifactId>
      <version>1.2</version>
    </dependency>
    <!-- 映入JSON -->
    <dependency>
      <groupId>org.codehaus.jackson</groupId>
      <artifactId>jackson-mapper-asl</artifactId>
      <version>1.9.13</version>
    </dependency>
    <!-- 上传组件包 -->
    <dependency>
      <groupId>commons-fileupload</groupId>
      <artifactId>commons-fileupload</artifactId>
      <version>1.3.1</version>
    </dependency>
    <dependency>
      <groupId>commons-io</groupId>
      <artifactId>commons-io</artifactId>
      <version>2.4</version>
    </dependency>
    <dependency>
      <groupId>commons-codec</groupId>
      <artifactId>commons-codec</artifactId>
      <version>1.9</version>
    </dependency>
  </dependencies>
  <build>
    <finalName>${project.artifactId}</finalName>


    <resources>
      <resource>
        <directory>src/main/java</directory>
        <includes>
          <include>**/*.properties</include>
          <include>**/*.xml</include>
        </includes>
        <!-- 是否替换资源中的属性-->
        <filtering>false</filtering>
      </resource>
      <resource>
        <directory>src/main/resources</directory>
      </resource>
    </resources>
    <plugins>
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.2</version>
        <configuration>
          <url>http://localhost:8080/manager/text</url>
          <server>tomcat7</server>
          <path>/${project.artifactId}</path>
          <update>true</update>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

web.xml中加上spring mvc的配置：

<servlet>
		<servlet-name>SpringMVC</servlet-name>
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
		<init-param>
			<param-name>contextConfigLocation</param-name>
			<param-value>classpath:spring-mvc.xml</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
		<async-supported>true</async-supported>
	</servlet>
	<servlet-mapping>
		<servlet-name>SpringMVC</servlet-name>
		<!-- 此处可以可以配置成*.do，对应struts的后缀习惯 -->
		<url-pattern>/</url-pattern>
	</servlet-mapping>

还有spring的配置文件，加上注解相关的配置：

<!-- 启动SpringMVC的注解功能，完成请求和注解POJO的映射 -->
	<bean
		class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
		<property name="messageConverters">
			<list>
				<!-- JSON转换器 -->
				<ref bean="mappingJacksonHttpMessageConverter" />
			</list>
		</property>
	</bean>

其余的配置可以自行设置，或者参考我上传到git上的源码；

创建配置属性的bean

本次实战的示例，以"电脑"为例，有两个属性：操作系统和内存大小，如下：

package com.bolingcavalry;

/**
 * Description:
 *
 * @author willzhao
 * @email zq2599@gmail.com
 * @date 2017/7/1 22:15
 */
public class Computer {

    /**
     * 操作系统
     */
    private String os;

    /**
     * 内存大小
     */
    private int ram;

    public String getOs() {
        return os;
    }

    public void setOs(String os) {
        this.os = os;
    }

    public int getRam() {
        return ram;
    }

    public void setRam(int ram) {
        this.ram = ram;
    }
}

创建XSD文件

在工程的src\main\resources\META-INF\computer.xsd目录下创建computer.xsd文件，内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema
        xmlns="http://blog.csdn.net/boling_cavalry/schema/computer"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:beans="http://www.springframework.org/schema/beans"
        targetNamespace="http://blog.csdn.net/boling_cavalry/schema/computer"
        elementFormDefault="qualified"
        attributeFormDefault="unqualified">
    <xsd:import namespace="http://www.springframework.org/schema/beans"/>
    <xsd:element name="computer">
        <xsd:complexType>
            <xsd:complexContent>
                <xsd:extension base="beans:identifiedType">
                    <xsd:attribute name="os" type="xsd:string"/>
                    <xsd:attribute name="ram" type="xsd:int"/>
                </xsd:extension>
            </xsd:complexContent>
        </xsd:complexType>
    </xsd:element>
</xsd:schema>

注意xmlns和targetNamespace的内容，在外部使用时也会用到，还有就是xsd:element节点，里面对computer的两个属性做了约束；

创建自定义BeanDefinitionParser，制定配置信息的解析规则

接下来要写个BeanDefinitionParser，作用是拿到xml中的computer节点后，该如何从这个节点中取得有效的信息给spring环境，源码如下：

public class ComputerBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {
    @Override
    protected Class<?> getBeanClass(Element element) {
        return Computer.class;
    }

    @Override
    protected void doParse(Element element, BeanDefinitionBuilder builder) {
        String os = element.getAttribute("os");
        String ramStr = element.getAttribute("ram");

        if(StringUtils.hasText(os)){
            builder.addPropertyValue("os", os);
        }
        if(StringUtils.hasText(ramStr)){
            builder.addPropertyValue("ram", Integer.valueOf(ramStr));
        }
    }
}

getBeanClass方法决定了解析节点后返回的bean的类型；
doParse方法的入参中收到了computer节点，在方法中解析"os"和"ram"两个节点，然后调用builder.addPropertyValue可以把解析结果传入builder中；

创建自定义NamespaceHandler，规定配置信息的解析器

自定义的NamespaceHandler，可以告诉spring环境，遇到computer的配置信息后，应该用ComputerBeanDefinitionParser去解析，代码很少，如下：

public class ComputerNamespaceHandler extends NamespaceHandlerSupport {
    public void init() {
        registerBeanDefinitionParser("computer", new ComputerBeanDefinitionParser());
    }
}

添加spring.handlers文件

在src\main\resources\META-INF\目录下，添加spring.handlers文件，内容只有一行，如下：

http\://blog.csdn.net/boling_cavalry/schema/computer=com.bolingcavalry.ComputerNamespaceHandler

添加spring.schemas文件

在src\main\resources\META-INF\目录下，添加spring.schemas文件，内容只有一行，如下：

http\://blog.csdn.net/boling_cavalry/schema/computer.xsd=META-INF/computer.xsd

在工程中配置一个这样的属性

准备得差不多了，可以验证一下啦，在spring的配置文件中，如果要用到这个属性，可以按照如下方式来写：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xmlns:bolingcavalry="http://blog.csdn.net/boling_cavalry/schema/computer"
	xsi:schemaLocation="http://www.springframework.org/schema/beans  
                            http://www.springframework.org/schema/beans/spring-beans-3.1.xsd  
                            http://www.springframework.org/schema/context  
                            http://www.springframework.org/schema/context/spring-context-3.1.xsd  
                            http://www.springframework.org/schema/mvc  
                            http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd
                            http://blog.csdn.net/boling_cavalry/schema/computer
							http://blog.csdn.net/boling_cavalry/schema/computer.xsd">

	<bolingcavalry:computer id="computer" os="centos" ram="8" />
</beans>

除了bolingcavalry:computer的配置，还要注意xmlns:bolingcavalry的配置，还有xsi:schemaLocation中“http://blog.csdn.net/boling_cavalry/schema/computer"和
"http://blog.csdn.net/boling_cavalry/schema/computer.xsd”也不要遗漏。

启动web工程，验证配置

为了验证配置是生效的，我们写一个controller在浏览器中显示配置信息，代码如下：

@Controller
public class HelloController {

	private static SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

	@Autowired
	Computer computer;

	@RequestMapping("/hello")
	@ResponseBody
	public String toIndex(HttpServletRequest request, Model model) {
		return "hello 001 [" + sdf.format(new Date()) + "], computer os [" + computer.getOs() + "], ram [" + computer.getRam() + "]";
	}
}

computer提供autowire注入，在web响应的时候会输出它的两个属性，现在启动tomcat并部署这个webapp，在浏览器中输入http://localhost:8080/springschemademo/hello，就能看到如下输出：

这里写图片描述

以上就是spring自定义schema的实战内容，这里只是为了快速体验这个功能，实际的应用中应该是把这种能力封装到库中，然后提供给应用方来使用，我们将在后续的实战中体验这种用法。

欢迎关注我的公众号

在这里插入图片描述

程序员欣宸
关注
  • 4
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Spring中自定义Schema如何解析生效详解
08-27
Spring2.5在2.0的基于Schema的Bean配置的基础之上，再增加了扩展XML配置的机制。通过该机制，我们可以编写自己的Schema，并根据自定义的Schema用自定的标签配置Bean，下面这篇文章主要介绍了关于Spring中自定义Schema如何解析生效的相关资料，需要的朋友可以参考下
Spring自定义配置Schema可扩展(二)
09-02
主要介绍了Spring自定义配置Schema可扩展(二)的相关资料,需要的朋友可以参考下
Spring自定义配置Schema可扩展(一)
09-02
本教程主要介绍如何扩展Spring的xml配置，让Spring能够识别我们自定义的Schema和Annotation，,需要的朋友可以参考下
Spring实战之使用util:命名空间简化配置操作示例
01-20
本文实例讲述了Spring使用util:命名空间简化配置操作。分享给大家供大家参考，具体如下： 一 配置 <?xml version=1.0 encoding=GBK?> <!-- 指定Spring配置文件的根元素和Schema 导入p:命名空间和util:命名空间的元素 --> <beans xmlns=http://www.springframework.org/schema/beans xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:p=http://www.springframew
自定义 Schema 解析 Spring Bean
08-08
NULL 博文链接：https://bodu-li.iteye.com/blog/2145400
接口文档管理系列 Springboot集成springdoc
wangxudongx的专栏
07-26 4499
接口文档管理系列 Springboot集成springdocspringdoc架构图如何使用？引入依赖码代码swagger和knife4j配置类定义modelControllerknife4j springdoc-openapi 带有Spring-boot的OpenAPI 3库 springdoc-openapi Java库有助于使用Spring Boot项目自动生成API文档。springdoc-openapi的工作原理是在运行时检查应用程序，以基于spring配置，类结构和各种注释来推断API语义。
SpringDoc手动添加Schemas/ApiModels方法
TOUTATIS.CN
07-28 579
springdoc不显示手动添加的schemas解决方案
详解Schema
yuan_xw的专栏
07-08 2442
Schema(important!) 1.XML Schema是用一种套预选规定好的XML元素和属性创建的，这些元素和属性定义了XML文档的结构和内容模式。  2.XML Schema是规定XML文档实例的结构和每个元素/属性的数据类型。   SQL-------------->Xpath   数据库----------->XML文档   表结构----------->Schema
@Schema和@ApiModel等注解的联系
mythangelboy的博客
04-07 1万+
我在看公司之前的文档，发现了@schema注解，不太了解，所以查询了一些资料，把我的见解记录下：开始的时候，没查到太多信息，后来查到了，原来就是用过的@APImodel注解，一个是swagger2常用的注解，一个是swagger3常用的注解。
Spring常用注解（绝对经典）
热门推荐
weixin_43745321的博客
05-25 1万+
目录 一、前言 1、xml和注解的最佳实践： 2、使用注解唯一需要注意的就是，必须开启注解的支持： 二、Spring的常用注解 1、给容器中注入组件 2、注入bean的注解 3、@JsonIgnore 4、初始化和销毁方法 5、Java配置类相关注解 6、切面（AOP）相关注解 7、@Bean的属性支持 8、@Value注解 9、环境切换 10、异步相关 11、定时任务相关 12、Enable***注解说明 13、测试相关注解 14、@EqualsAndHashCode.
秒懂SpringBoot之如何集成SpringDoc（全网目前最新最系统最全面的springdoc教程）
ShuSheng007的程序人生
06-22 1305
近来颇为懈怠，博客竟两月有余未发一篇，惭愧惭愧。值此端午佳节（dragon boat festival）作为调包高手、API小王子的我就聊聊API文档的那些事吧，如果你也是API小王子，那我们就可以在一起欢度佳节了，哈哈…我惯用Java，惯用Spring，所以这里谈论的是关于springboot中如何处理文档的内容终于写完了，要写一篇逻辑清晰，对初学者友好的博客可真不容易。当然我写博客主要是为了自己梳理知识，但是我一直秉承着解决自己初次接触时候的困难场景来写的，相信对其他小朋友会有很大的帮助。
01_学习springdoc的基本使用
ShiJunzhiCome的博客
02-01 1万+
网上冲浪🏄🏻‍♂️时，无意间发现 java web 应用程序的在线接口文档，除了耳熟能详的 swagger 之外，还有个 springdoc。这也许就叫惊喜( ͡• ͜ʖ ͡• )还记得要使用 swagger2 的话，springboot 项目里面需要引入 springfox 的依赖。swagger2 遵循的是 OpenAPI 2 规范。现在已经有了 OpenAPI 3 规范，springdoc 便是 OpenAPI 3 和 springboot 的结合，是 springfox 的完美替代品。
基于SpringBoot3从零配置SpringDoc
程序员雅痞的博客
05-06 5475
为了方便调试，更好的服务于前后端分离式的工作模式，我们给项目引入Swagger。本文基于Spring Boot 3.0.6引入了SpringDoc和Knife4j,并提供了常用的注解示例。
SpringDoc注解解析
最新发布
qq_29012499的博客
01-06 2740
SpringDoc注解的使用，它是基于OpenAPI 3和Swagger 3的现代化解决方案，相较于旧版的Swagger2(SpringFox)，SpringDoc提供了更简洁、更直观的注解方式。
schema的几个重要知识
更好的自己的博客
09-27 3559
1.schema的作用是用来对xml文档做约束，保证xml文档的正确性。 2.namespace：相当于schema文件的id 3.targetNamespace属性: 用来指定schema文件的namespace的值 4.xmlns属性: 引入一个约束，它的值是一个schema文件的namespace值。 5.schema:location属性: 用来指定引入
【Schema详解】
旺旺的博客
05-26 5279
目录前言Schemabook.xsd文档解析< schema > 元素简单的类型XSD 简易元素XSD 属性XSD 限定 / FacetsXSD复合元素不懂请看例题book.xml文档解析总结 前言 |ू･ω･` ) 首先，本章节主要是在【XML之DTD】之后写的一个跟DTD可以替换来用的XML schema 因为DTD虽然可以解决目前的小的问题，可DTD相对Schema来说还是有点力...
@Schema和@ApiModel注解
weixin_53618357的博客
09-04 1664
是。
Spring OXM + XStream 简单实例
....
05-30 421
测试所有的jar包: 1. spring-oxm.jar 2. xmlpull.jar 3. xpp3.jar 4. xstream.jar   一. 上下文配置:   &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;beans xmlns="http://www.springframework.org/schema/bean...
SpringBoot学习
weixin_51326478的博客
09-04 288
SpringBoot的自动配置是一个运行时（更准确的说，是应用程序启动时）的过程，考虑了众多因素，才决定Spring配置应该用哪个，不应该用哪个。该过程是SpringBoot自动完成的。提供了一些大型项目中常见的非功能性特征，如嵌入式服务器、安全、指标、健康检查、外部配置。：SpringBoot提供了一种快速开发Spring项目的方式，而不是对Spring的功能上的增强。起步依赖本质上是一个Maven项目对象模型，定义了对其他库的。这些东西加在一起即支持某项目功能。
springboot yml 自定义属性没提示
05-05
如果你在编写Spring Boot的YAML配置文件时，自定义属性没有提示，可能是因为你的IDE没有正确地识别你的自定义属性。 为了解决这个问题，你可以在YAML配置文件中添加一个schema，以告诉IDE如何识别自定义属性。以下是一个示例： ``` # 添加 Yaml 文件的 Schema spring: profiles: active: dev # 自定义属性 my: name: chit age: 18 # 告诉IDE如何解析自定义属性 my.schema: type: object properties: name: type: string age: type: integer ``` 在这个示例中，我们添加了一个名为`my.schema`的属性，它告诉IDE如何解析自定义属性。在你的IDE中，你可能需要手动启用YAML支持，或者安装一个YAML插件，以便正确地解析YAML配置文件。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

程序员欣宸

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值