博客

Spring Boot中的Endpoint可以提供很多便利信息，但是有时候自带的信息不能满足需要，就需要我们自己创建一个Endpoint。

对于一个项目而言我们希望能够了解到一些基本的信息，比如项目的构建环境，git仓库信息，CI的build number等等。

Netflix的nebula项目提供了很多gradle的插件，而搜集信息我们可以使用gradle-info-plugin。

buildscript {
    repositories { jcenter() }
    dependencies { classpath 'com.netflix.nebula:gradle-info-plugin:3.+' }
}

apply plugin: 'nebula.info'

这样在gradle构建项目的时候就会自动搜集信息，并存储在Properties文件中。这样就可以自定义一个Endpoint来展示这些信息。

import com.google.common.collect.Maps;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.springframework.boot.actuate.endpoint.AbstractEndpoint;

import org.springframework.stereotype.Component;

import java.io.IOException;
import java.io.InputStream;

import java.util.HashMap;
import java.util.Map;
import java.util.Properties;


@Component
public class VersionEndpoint extends AbstractEndpoint<Map<String, Object>> {
    private Logger logger = LoggerFactory.getLogger(this.getClass());

    public VersionEndpoint() {
        super("version", false);
    }

    @Override
    public Map<String, Object> invoke() {
        HashMap<String, Object> maps = Maps.newHashMap();
        InputStream inputStream = this.getClass().getClassLoader()
                                      .getResourceAsStream("META-INF/{项目名字}.properties");

        try {
            Properties properties = new Properties();
            properties.load(inputStream);

            for (Map.Entry<Object, Object> entry : properties.entrySet()) {
                maps.put(String.valueOf(entry.getKey()), entry.getValue());
            }
        } catch (IOException e) {
            logger.error("Error when process file", e);
        }

        return maps;
    }
}

这样我们访问/version时就可以看到类似这样的输出

参考资料

https://github.com/nebula-plugins/gradle-info-plugin

Spring Framework 4.3有两个有趣的改动，第一个是单一构造函数的自动注入，第二个就是注入依赖条件的配置。

来看看之前版本的代码

@Service
public class FooService {

    private final FooRepository repository;

    @Autowired
    public FooService(FooRepository repository) {
        this.repository = repository
    }
}

@Autowired注解是一个很关键的东西，如果你忘记了，那么运行就会出现null错误。在新版本中，你无需这个注解了，Spring会自动处理这种情况。当然，这个功能同样对@Configuration等有效。

新的ObjectProvider可以提供两个特别的方法getIfAvailable和getIfUnique。比如这种

@Service
public class FooService {

    private final FooRepository repository;

    public FooService(ObjectProvider<FooRepository> repositoryProvider) {
        this.repository = repositoryProvider.getIfUnique();
    }
}

具体的实现可以参考DefaultListableBeanFactory，比如

public Object getIfUnique() throws BeansException
{
	DependencyDescriptor descriptorToUse = new DependencyDescriptor( descriptor )
	{
		@Override
		public boolean isRequired()
		{
			return(false);
		}


		@Override
		public Object resolveNotUnique( Class<?> type, Map<String, Object> matchingBeans )
		{
			return(null);
		}
	};
	if ( this.optional )
	{
		return(new OptionalDependencyFactory().createOptionalDependency( descriptorToUse, this.beanName ) );
	}else  {
		return(doResolveDependency( descriptorToUse, this.beanName, null, null ) );
	}
}

Spring Boot推出后取得了巨大的成功，方便快速上手，还附带了很多product-ready特性。对微服务架构也很友好。

随着Spring Boot一起推出的还有Spring Boot众多的starter。当你喜欢使用某些组件时，试试starter，只需要使用构建工具引用一个依赖，你就可以快速获得它。

了解starter之后你也可以自己实现自己的starter，以便其他同事快速使用公司内部特有的组件。

spring.factories

每个starter都有一个spring.factories文件，位于META-INF目录下。

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.MessageSourceAutoConfiguration,\

随便开一个文件来看

@Configuration
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
@EnableConfigurationProperties(RabbitProperties.class)
@Import(RabbitAnnotationDrivenConfiguration.class)
public class RabbitAutoConfiguration {

	@Bean
	@ConditionalOnProperty(prefix = "spring.rabbitmq", name = "dynamic", matchIfMissing = true)
	@ConditionalOnMissingBean(AmqpAdmin.class)
	public AmqpAdmin amqpAdmin(ConnectionFactory connectionFactory) {
		return new RabbitAdmin(connectionFactory);
	}

可以看到很多@ConditionalOnXXX的注解，这就是关键的地方。

条件注解

在引入starter后可能会提供一些暴露给上下文的bean，但是有时候又是不需要的，比如用户自己提供了对应的bean，或者用户通过配置关闭了部分功能。

主要的条件有这几种

• OnBeanCondition
• OnClassCondition
• OnExpressionCondition
• OnJavaCondition
• OnJndiCondition
• OnPropertyCondition
• OnResourceCondition
• OnWebApplicationCondition
• OnMissingBean
• OnProperty

当对应条件满足时，响应的代码才会执行。

比如starter中并没有引入对应的具体实现，那么这种情况下就不应该实例化相应的配置和实例。

比如CassandraDataAutoConfiguration，在没有Cassandra对应实现情况下就应该直接忽略

@ConditionalOnClass({ Cluster.class, CassandraAdminOperations.class })

如果用户自己配置了CassandraMappingContext，那么starter中就不应该再提供任何MappingContext配置

@Bean
	@ConditionalOnMissingBean
	public CassandraMappingContext cassandraMapping() {
		return new BasicCassandraMappingContext();
	}

ConditionalOnExpression我一直觉得是一个很有用处的配置，使用SpEL基本上能够实现所有情况判断，但是我并没有看到任何一个用这个的例子。

活用这些配置，可以轻易创造出很多灵活的starter。

Spring Boot对于日志的支持是比较到位的，默认logback实现，输出到console。

如果你的console支持ANSI，那么还可以选择彩色输出。

很多时候可能并不只是希望日志能够输出到console，还希望能够保存到目录，甚至后期配合splunk等等做分析统计。

Spring Boot会检测logging.file和logging.path是否存在，如果存在的话就会输出到文件中。这个配置可以在application.properties中设置。

如果应用打包已经完成了，可以直接在命令行配置

java -jar app.jar -Dlogging.path=/alidata/log