template) {
59 | if (StringUtils.hasLength(properties.getPrefix())) {
60 | return new RedisFrequencyLimiter(properties.getPrefix(), template);
61 | }
62 | return new RedisFrequencyLimiter(template);
63 | }
64 | }
65 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-extra/src/main/java/site/zido/coffee/autoconfigure/extra/package-info.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.extra;
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-extra/src/main/resources/META-INF/spring-configuration-metadata.json:
--------------------------------------------------------------------------------
1 | {
2 | "groups": [
3 | {
4 | "name": "coffee.limiter",
5 | "type": "site.zido.coffee.common.limiter.LimiterProperties",
6 | "sourceType": "site.zido.coffee.common.limiter.LimiterAutoConfiguration",
7 | "sourceMethod": "createProperties()",
8 | "description": "限流器相关属性"
9 | }
10 | ],
11 | "properties": [
12 | {
13 | "name": "coffee.limiter.prefix",
14 | "type": "java.lang.String",
15 | "sourceType": "site.zido.coffee.common.limiter.LimiterProperties",
16 | "description": "设置limiter前缀"
17 | }
18 | ],
19 | "hints": []
20 | }
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-extra/src/main/resources/META-INF/spring.factories:
--------------------------------------------------------------------------------
1 | org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
2 | site.zido.coffee.autoconfigure.extra.limiter.LimiterRedisConfiguration,\
3 | site.zido.coffee.autoconfigure.extra.limiter.LimiterAutoConfiguration,\
4 | site.zido.coffee.autoconfigure.extra.limiter.LimiterExceptionAutoHandlerConfiguration
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-rest-security/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 |
6 | coffee-autoconfigures
7 | site.zido
8 | 0.3.0-SNAPSHOT
9 |
10 | 4.0.0
11 |
12 | coffee-autoconfigure-rest-security
13 |
14 |
15 | site.zido
16 | coffee-webmvc
17 |
18 |
19 | site.zido
20 | coffee-rest-security
21 |
22 |
23 | org.springframework.data
24 | spring-data-redis
25 | compile
26 | true
27 |
28 |
29 |
30 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-rest-security/src/main/java/site/zido/coffee/autoconfigure/security/rest/AuthorizationStorageJWTCondition.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.security.rest;
2 |
3 | import org.springframework.context.annotation.Condition;
4 | import org.springframework.context.annotation.ConditionContext;
5 | import org.springframework.core.type.AnnotatedTypeMetadata;
6 |
7 | public class AuthorizationStorageJWTCondition implements Condition {
8 |
9 | @Override
10 | public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
11 | String storeType = context.getEnvironment().getProperty("spring.security.secureStoreType", "JWT");
12 | return SecureStoreType.JWT.name().equalsIgnoreCase(storeType);
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-rest-security/src/main/java/site/zido/coffee/autoconfigure/security/rest/RestSecurityAutoConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.security.rest;
2 |
3 | import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
4 | import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
5 | import org.springframework.boot.autoconfigure.security.SecurityDataConfiguration;
6 | import org.springframework.boot.autoconfigure.security.SecurityProperties;
7 | import org.springframework.boot.autoconfigure.security.servlet.SpringBootWebSecurityConfiguration;
8 | import org.springframework.boot.autoconfigure.security.servlet.WebSecurityEnablerConfiguration;
9 | import org.springframework.boot.context.properties.EnableConfigurationProperties;
10 | import org.springframework.context.ApplicationEventPublisher;
11 | import org.springframework.context.annotation.Bean;
12 | import org.springframework.context.annotation.Configuration;
13 | import org.springframework.context.annotation.Import;
14 | import org.springframework.security.authentication.AuthenticationEventPublisher;
15 | import org.springframework.security.authentication.DefaultAuthenticationEventPublisher;
16 |
17 | /**
18 | * rest security自动配置类
19 | *
20 | * SpringBootRestSecurityConfiguration代替原来的{@link SpringBootWebSecurityConfiguration}
21 | *
22 | * 去掉{@link WebSecurityEnablerConfiguration}以取消
23 | * {@link org.springframework.security.config.annotation.web.configuration.EnableWebSecurity}注解所带来的其他自动配置
24 | *
25 | * @author zido
26 | */
27 | @Configuration(proxyBeanMethods = false)
28 | @ConditionalOnClass(DefaultAuthenticationEventPublisher.class)
29 | @EnableConfigurationProperties(SecurityProperties.class)
30 | @Import({SpringBootRestSecurityConfiguration.class,
31 | WebSecurityEnablerConfiguration.class,
32 | SecurityDataConfiguration.class})
33 | public class RestSecurityAutoConfiguration {
34 |
35 | @Bean
36 | @ConditionalOnMissingBean(AuthenticationEventPublisher.class)
37 | public DefaultAuthenticationEventPublisher authenticationEventPublisher(ApplicationEventPublisher publisher) {
38 | return new DefaultAuthenticationEventPublisher(publisher);
39 | }
40 |
41 | }
42 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-rest-security/src/main/java/site/zido/coffee/autoconfigure/security/rest/RestSecurityFilterAutoConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.security.rest;
2 |
3 | import org.springframework.boot.autoconfigure.AutoConfigureAfter;
4 | import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
5 | import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
6 | import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
7 | import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication.Type;
8 | import org.springframework.boot.autoconfigure.security.SecurityProperties;
9 | import org.springframework.boot.context.properties.EnableConfigurationProperties;
10 | import org.springframework.boot.web.servlet.DelegatingFilterProxyRegistrationBean;
11 | import org.springframework.context.annotation.Bean;
12 | import org.springframework.context.annotation.Configuration;
13 | import org.springframework.security.web.context.AbstractSecurityWebApplicationInitializer;
14 |
15 | import javax.servlet.DispatcherType;
16 | import java.util.EnumSet;
17 | import java.util.stream.Collectors;
18 |
19 | /**
20 | * 单独提取filter配置，以确保自动配置顺序
21 | *
22 | * @author zido
23 | */
24 | @Configuration(proxyBeanMethods = false)
25 | @ConditionalOnWebApplication(type = Type.SERVLET)
26 | @EnableConfigurationProperties(SecurityProperties.class)
27 | @ConditionalOnClass({AbstractSecurityWebApplicationInitializer.class})
28 | @AutoConfigureAfter(RestSecurityAutoConfiguration.class)
29 | public class RestSecurityFilterAutoConfiguration {
30 |
31 | private static final String DEFAULT_FILTER_NAME = AbstractSecurityWebApplicationInitializer.DEFAULT_FILTER_NAME;
32 |
33 | @Bean
34 | @ConditionalOnBean(name = DEFAULT_FILTER_NAME)
35 | public DelegatingFilterProxyRegistrationBean securityFilterChainRegistration(
36 | SecurityProperties securityProperties) {
37 | DelegatingFilterProxyRegistrationBean registration = new DelegatingFilterProxyRegistrationBean(
38 | DEFAULT_FILTER_NAME);
39 | registration.setOrder(securityProperties.getFilter().getOrder());
40 | registration.setDispatcherTypes(getDispatcherTypes(securityProperties));
41 | return registration;
42 | }
43 |
44 | private EnumSet getDispatcherTypes(SecurityProperties securityProperties) {
45 | if (securityProperties.getFilter().getDispatcherTypes() == null) {
46 | return null;
47 | }
48 | return securityProperties.getFilter().getDispatcherTypes().stream()
49 | .map((type) -> DispatcherType.valueOf(type.name()))
50 | .collect(Collectors.collectingAndThen(Collectors.toSet(), EnumSet::copyOf));
51 | }
52 |
53 | }
54 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-rest-security/src/main/java/site/zido/coffee/autoconfigure/security/rest/SecureStoreType.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.security.rest;
2 |
3 | public enum SecureStoreType {
4 | // spring security自带的cookie
5 | COOKIE,
6 | //JWT token 标准
7 | JWT,
8 | //TODO 传统token支持
9 | TOKEN
10 | }
11 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-rest-security/src/main/java/site/zido/coffee/autoconfigure/security/rest/WebSecurityAutoFilter.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.security.rest;
2 |
3 | import org.springframework.boot.autoconfigure.AutoConfigurationImportFilter;
4 | import org.springframework.boot.autoconfigure.AutoConfigurationMetadata;
5 | import org.springframework.context.EnvironmentAware;
6 | import org.springframework.core.env.Environment;
7 |
8 | import java.util.Arrays;
9 | import java.util.HashSet;
10 | import java.util.Set;
11 |
12 | public class WebSecurityAutoFilter implements AutoConfigurationImportFilter, EnvironmentAware {
13 | private static final Set WEB_SECURITY_SKIP = new HashSet<>(
14 | Arrays.asList("org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration",
15 | "org.springframework.boot.autoconfigure.security.servlet.SecurityFilterAutoConfiguration")
16 | );
17 |
18 | private static final Set REST_SECURITY_SKIP = new HashSet<>(
19 | Arrays.asList("site.zido.coffee.autoconfigure.security.rest.RestSecurityFilterAutoConfiguration",
20 | "site.zido.coffee.autoconfigure.security.rest.RestSecurityAutoConfiguration")
21 | );
22 |
23 | private boolean useRest = true;
24 |
25 | @Override
26 | public boolean[] match(String[] classNames, AutoConfigurationMetadata metadata) {
27 | boolean[] matches = new boolean[classNames.length];
28 |
29 | for (int i = 0; i < classNames.length; i++) {
30 | matches[i] = !(useRest ? WEB_SECURITY_SKIP : REST_SECURITY_SKIP).contains(classNames[i]);
31 | }
32 | return matches;
33 | }
34 |
35 | @Override
36 | public void setEnvironment(Environment environment) {
37 | this.useRest = "JWT".equalsIgnoreCase(environment.getProperty("spring.security.secureStoreType", "JWT"));
38 | }
39 | }
40 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-rest-security/src/main/java/site/zido/coffee/autoconfigure/security/rest/authorize/PhoneCodeAutoConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.security.rest.authorize;
2 |
3 | import org.springframework.boot.autoconfigure.AutoConfigureAfter;
4 | import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
5 | import org.springframework.boot.context.properties.EnableConfigurationProperties;
6 | import org.springframework.context.annotation.Bean;
7 | import org.springframework.context.annotation.Configuration;
8 | import org.springframework.util.StringUtils;
9 | import site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties;
10 | import site.zido.coffee.security.authentication.phone.MemoryPhoneCodeCache;
11 | import site.zido.coffee.security.authentication.phone.PhoneCodeCache;
12 |
13 | @Configuration
14 | @EnableConfigurationProperties({CoffeeSecurityProperties.class})
15 | @AutoConfigureAfter(RedisPhoneCodeConfiguration.class)
16 | public class PhoneCodeAutoConfiguration {
17 | @ConditionalOnMissingBean(PhoneCodeCache.class)
18 | @Bean
19 | public PhoneCodeCache getCache(CoffeeSecurityProperties properties) {
20 | return new MemoryPhoneCodeCache() {
21 | @Override
22 | public void put(String phone, String code) {
23 | super.put(phone, code);
24 | }
25 |
26 | @Override
27 | public String getCode(String phone) {
28 | if (StringUtils.hasText(properties.getPhoneCode().getKeyPrefix())) {
29 | phone = properties.getPhoneCode().getKeyPrefix() + phone;
30 | }
31 | return super.getCode(phone);
32 | }
33 |
34 | @Override
35 | public long getTimeout() {
36 | return properties.getPhoneCode().getTimeout() == null
37 | ? super.getTimeout()
38 | : properties.getPhoneCode().getTimeout();
39 | }
40 | };
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-rest-security/src/main/java/site/zido/coffee/autoconfigure/security/rest/authorize/RedisPhoneCodeConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.security.rest.authorize;
2 |
3 | import org.springframework.beans.factory.annotation.Autowired;
4 | import org.springframework.beans.factory.annotation.Qualifier;
5 | import org.springframework.boot.autoconfigure.AutoConfigureAfter;
6 | import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
7 | import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
8 | import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration;
9 | import org.springframework.context.annotation.Bean;
10 | import org.springframework.context.annotation.Configuration;
11 | import org.springframework.data.redis.connection.RedisConnectionFactory;
12 | import org.springframework.data.redis.core.StringRedisTemplate;
13 | import site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties;
14 | import site.zido.coffee.security.authentication.phone.PhoneCodeCache;
15 | import site.zido.coffee.security.authentication.phone.SpringRedisPhoneCodeCache;
16 |
17 | import java.util.concurrent.TimeUnit;
18 |
19 | @Configuration
20 | @ConditionalOnBean(RedisConnectionFactory.class)
21 | @AutoConfigureAfter(RedisAutoConfiguration.class)
22 | public class RedisPhoneCodeConfiguration {
23 | public static final String TEMPLATE_BEAN_NAME = "phoneCodeCacheTemplate";
24 |
25 | @Bean
26 | @ConditionalOnMissingBean(PhoneCodeCache.class)
27 | public PhoneCodeCache phoneCodeCache(@Autowired CoffeeSecurityProperties properties,
28 | @Autowired @Qualifier(TEMPLATE_BEAN_NAME) StringRedisTemplate template) {
29 | SpringRedisPhoneCodeCache cache = new SpringRedisPhoneCodeCache();
30 | cache.setKeyPrefix(properties.getPhoneCode().getKeyPrefix());
31 | if (properties.getPhoneCode().getTimeout() != null) {
32 | cache.setTimeout(properties.getPhoneCode().getTimeout(), TimeUnit.SECONDS);
33 | }
34 | cache.setTemplate(template);
35 | return cache;
36 | }
37 |
38 | @Bean(value = TEMPLATE_BEAN_NAME)
39 | @ConditionalOnMissingBean(name = TEMPLATE_BEAN_NAME)
40 | public StringRedisTemplate createTemplate(RedisConnectionFactory factory) {
41 | return new StringRedisTemplate(factory);
42 | }
43 | }
44 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-rest-security/src/main/resources/META-INF/spring-configuration-metadata.json:
--------------------------------------------------------------------------------
1 | {
2 | "groups": [
3 | {
4 | "name": "spring.security",
5 | "type": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties",
6 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties"
7 | },
8 | {
9 | "name": "spring.security.jwt",
10 | "type": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties$JwtProperties",
11 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties",
12 | "sourceMethod": "getJwt()"
13 | },
14 | {
15 | "name": "spring.security.phone-code",
16 | "type": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties$AuthorizationPhoneCodeProperties",
17 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties",
18 | "sourceMethod": "getPhoneCode()"
19 | }
20 | ],
21 | "properties": [
22 | {
23 | "name": "spring.security.jwt.auto-refresh",
24 | "type": "java.lang.Boolean",
25 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties$JwtProperties",
26 | "defaultValue": true
27 | },
28 | {
29 | "name": "spring.security.jwt.expiration",
30 | "type": "java.lang.Long",
31 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties$JwtProperties"
32 | },
33 | {
34 | "name": "spring.security.jwt.header",
35 | "type": "java.lang.String",
36 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties$JwtProperties",
37 | "defaultValue": "Authorization"
38 | },
39 | {
40 | "name": "spring.security.jwt.refresh-header",
41 | "type": "java.lang.String",
42 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties$JwtProperties",
43 | "defaultValue": "Refresh-Token"
44 | },
45 | {
46 | "name": "spring.security.jwt.refresh-secret",
47 | "type": "java.lang.String",
48 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties$JwtProperties"
49 | },
50 | {
51 | "name": "spring.security.jwt.refresh-support",
52 | "type": "java.lang.Boolean",
53 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties$JwtProperties",
54 | "defaultValue": false
55 | },
56 | {
57 | "name": "spring.security.jwt.renew-in-ms",
58 | "type": "java.lang.Long",
59 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties$JwtProperties"
60 | },
61 | {
62 | "name": "spring.security.jwt.secret",
63 | "type": "java.lang.String",
64 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties$JwtProperties"
65 | },
66 | {
67 | "name": "spring.security.phone-code-enable",
68 | "type": "java.lang.Boolean",
69 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties",
70 | "defaultValue": true
71 | },
72 | {
73 | "name": "spring.security.phone-code.key-prefix",
74 | "type": "java.lang.String",
75 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties$AuthorizationPhoneCodeProperties"
76 | },
77 | {
78 | "name": "spring.security.phone-code.timeout",
79 | "type": "java.lang.Long",
80 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties$AuthorizationPhoneCodeProperties",
81 | "defaultValue": 0
82 | },
83 | {
84 | "name": "spring.security.secure-store-type",
85 | "type": "site.zido.coffee.autoconfigure.security.rest.SecureStoreType",
86 | "sourceType": "site.zido.coffee.autoconfigure.security.rest.CoffeeSecurityProperties"
87 | }
88 | ],
89 | "hints": []
90 | }
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-rest-security/src/main/resources/META-INF/spring.factories:
--------------------------------------------------------------------------------
1 | org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
2 | site.zido.coffee.autoconfigure.security.rest.RestSecurityAutoConfiguration,\
3 | site.zido.coffee.autoconfigure.security.rest.RestSecurityFilterAutoConfiguration,\
4 | site.zido.coffee.autoconfigure.security.rest.authorize.PhoneCodeAutoConfiguration,\
5 | site.zido.coffee.autoconfigure.security.rest.authorize.RedisPhoneCodeConfiguration
6 | org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=\
7 | site.zido.coffee.autoconfigure.security.rest.WebSecurityAutoFilter
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-web/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 |
6 | coffee-autoconfigures
7 | site.zido
8 | 0.3.0-SNAPSHOT
9 |
10 | 4.0.0
11 |
12 | coffee-autoconfigure-web
13 |
14 |
15 | site.zido
16 | coffee-webmvc
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-web/src/main/java/site/zido/coffee/autoconfigure/web/CoffeeErrorMvcAutoConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.web;
2 |
3 | import org.springframework.beans.factory.ObjectProvider;
4 | import org.springframework.boot.autoconfigure.AutoConfigureBefore;
5 | import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
6 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
7 | import org.springframework.boot.autoconfigure.condition.SearchStrategy;
8 | import org.springframework.boot.autoconfigure.web.ServerProperties;
9 | import org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController;
10 | import org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration;
11 | import org.springframework.boot.autoconfigure.web.servlet.error.ErrorViewResolver;
12 | import org.springframework.boot.context.properties.EnableConfigurationProperties;
13 | import org.springframework.boot.web.servlet.error.ErrorAttributes;
14 | import org.springframework.boot.web.servlet.error.ErrorController;
15 | import org.springframework.context.annotation.Bean;
16 | import org.springframework.context.annotation.Configuration;
17 | import org.springframework.context.annotation.Import;
18 | import org.springframework.http.HttpStatus;
19 | import org.springframework.http.MediaType;
20 | import org.springframework.http.ResponseEntity;
21 | import org.springframework.web.bind.annotation.RequestMapping;
22 | import site.zido.coffee.autoconfigure.web.basic.CoffeeErrorAttributes;
23 | import site.zido.coffee.mvc.rest.HttpResponseBodyConfiguration;
24 | import site.zido.coffee.mvc.rest.HttpResponseBodyFactory;
25 | import site.zido.coffee.mvc.rest.OriginalResponse;
26 |
27 | import javax.servlet.http.HttpServletRequest;
28 | import java.util.Map;
29 | import java.util.stream.Collectors;
30 |
31 | @Configuration
32 | @EnableConfigurationProperties({ServerProperties.class})
33 | @Import(HttpResponseBodyConfiguration.class)
34 | @AutoConfigureBefore(ErrorMvcAutoConfiguration.class)
35 | @ConditionalOnProperty(value = "spring.coffee.web.global-exception", matchIfMissing = true, havingValue = "true")
36 | class CoffeeErrorMvcAutoConfiguration {
37 | private final ServerProperties serverProperties;
38 |
39 | public CoffeeErrorMvcAutoConfiguration(ServerProperties serverProperties) {
40 | this.serverProperties = serverProperties;
41 | }
42 |
43 | @ConditionalOnMissingBean(value = ErrorAttributes.class, search = SearchStrategy.CURRENT)
44 | @Bean
45 | public CoffeeErrorAttributes errorAttributes(HttpResponseBodyFactory factory) {
46 | return new CoffeeErrorAttributes(this.serverProperties.getError().isIncludeException(), factory);
47 | }
48 |
49 | @Bean
50 | @ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)
51 | public BasicErrorController basicErrorController(ErrorAttributes errorAttributes,
52 | ObjectProvider errorViewResolvers) {
53 | return new BasicErrorController(errorAttributes, this.serverProperties.getError(),
54 | errorViewResolvers.orderedStream().collect(Collectors.toList())) {
55 | @RequestMapping
56 | @OriginalResponse
57 | public ResponseEntity> error(HttpServletRequest request) {
58 | HttpStatus status = getStatus(request);
59 | if (status == HttpStatus.NO_CONTENT) {
60 | return new ResponseEntity<>(status);
61 | }
62 | Map body = getErrorAttributes(request, isIncludeStackTrace(request, MediaType.ALL));
63 | return new ResponseEntity<>(body, status);
64 | }
65 | };
66 | }
67 | }
68 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-web/src/main/java/site/zido/coffee/autoconfigure/web/GlobalExceptionEnablerConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.web;
2 |
3 | import org.springframework.boot.autoconfigure.AutoConfigureAfter;
4 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
5 | import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
6 | import org.springframework.context.annotation.Configuration;
7 |
8 | import site.zido.coffee.mvc.exceptions.EnableGlobalException;
9 |
10 | @EnableGlobalException
11 | @Configuration
12 | @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
13 | @ConditionalOnProperty(value = "spring.coffee.web.global-exception", matchIfMissing = true, havingValue = "true")
14 | @AutoConfigureAfter(GlobalResultEnablerConfiguration.class)
15 | public class GlobalExceptionEnablerConfiguration {
16 |
17 | }
18 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-web/src/main/java/site/zido/coffee/autoconfigure/web/GlobalResultEnablerConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.web;
2 |
3 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
4 | import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
5 | import org.springframework.context.annotation.Configuration;
6 | import org.springframework.context.annotation.Import;
7 | import site.zido.coffee.mvc.rest.EnableGlobalResult;
8 |
9 | @EnableGlobalResult
10 | @Configuration
11 | @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
12 | @ConditionalOnProperty(value = "spring.coffee.web.global-result", matchIfMissing = true, havingValue = "true")
13 | @Import(JavaxExceptionEnablerConfiguration.class)
14 | public class GlobalResultEnablerConfiguration {
15 | }
16 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-web/src/main/java/site/zido/coffee/autoconfigure/web/JavaxExceptionEnablerConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.web;
2 |
3 | import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
4 | import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
5 | import org.springframework.context.annotation.Configuration;
6 |
7 | /**
8 | * @author zido
9 | */
10 | @Configuration
11 | @ConditionalOnClass(name = "javax.validation.ConstraintViolationException")
12 | @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
13 | public class JavaxExceptionEnablerConfiguration {
14 | }
15 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-web/src/main/java/site/zido/coffee/autoconfigure/web/JsonAutoConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.web;
2 |
3 | import com.fasterxml.jackson.annotation.JsonInclude;
4 | import com.fasterxml.jackson.databind.DeserializationFeature;
5 | import com.fasterxml.jackson.databind.ObjectMapper;
6 | import org.springframework.beans.factory.annotation.Autowired;
7 | import org.springframework.beans.factory.annotation.Value;
8 | import org.springframework.boot.autoconfigure.AutoConfigureAfter;
9 | import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
10 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
11 | import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
12 | import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration;
13 | import org.springframework.context.annotation.Configuration;
14 |
15 | import java.util.List;
16 |
17 | /**
18 | * json配置
19 | *
20 | * @author zido
21 | */
22 | @Configuration(proxyBeanMethods = false)
23 | @ConditionalOnBean({ObjectMapper.class})
24 | @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
25 | @ConditionalOnProperty(prefix = "spring.coffee.json.auto-switch",
26 | value = "enable",
27 | havingValue = "true",
28 | matchIfMissing = true)
29 | @AutoConfigureAfter(JacksonAutoConfiguration.class)
30 | public class JsonAutoConfiguration {
31 |
32 | /**
33 | * 配置全局json序列化(开发模式)
34 | *
37 | */
38 | @Autowired
39 | public void setMapper(@Value("${spring.profiles.active:prod}") List profiles,
40 | ObjectMapper mapper) {
41 | if (profiles.contains("prod")) {
42 | prodObjectMapper(mapper);
43 | }
44 | }
45 |
46 | /**
47 | * 配置全局json序列化
48 | *
49 | * - null不参与序列化
50 | * - 属性不匹配会失败
51 | *
52 | */
53 | private void prodObjectMapper(ObjectMapper mapper) {
54 | mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
55 | mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-web/src/main/java/site/zido/coffee/autoconfigure/web/RequestLogEnablerConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.autoconfigure.web;
2 |
3 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
4 | import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
5 | import site.zido.coffee.mvc.logger.EnableRequestLogger;
6 |
7 | @EnableRequestLogger
8 | @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
9 | @ConditionalOnProperty(value = "spring.coffee.web.request-log", havingValue = "true")
10 | public class RequestLogEnablerConfiguration {
11 | }
12 |
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-web/src/main/resources/META-INF/spring-configuration-metadata.json:
--------------------------------------------------------------------------------
1 | {
2 | "groups": [],
3 | "properties": [
4 | {
5 | "name": "spring.coffee.json.auto-switch",
6 | "type": "java.lang.Boolean",
7 | "description": "设置是否自动根据环境切换json序列化行为"
8 | },
9 | {
10 | "name": "spring.coffee.web.global-result",
11 | "type": "java.lang.Boolean",
12 | "description": "设置是否使用全局封装统一返回对象"
13 | },
14 | {
15 | "name": "spring.coffee.web.global-exception",
16 | "type": "java.lang.Boolean",
17 | "description": "设置是否使用全局封装统一异常返回对象"
18 | }
19 | ],
20 | "hints": []
21 | }
--------------------------------------------------------------------------------
/coffee-autoconfigures/coffee-autoconfigure-web/src/main/resources/META-INF/spring.factories:
--------------------------------------------------------------------------------
1 | org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
2 | site.zido.coffee.autoconfigure.web.JsonAutoConfiguration,\
3 | site.zido.coffee.autoconfigure.web.GlobalResultEnablerConfiguration,\
4 | site.zido.coffee.autoconfigure.web.GlobalExceptionEnablerConfiguration,\
5 | site.zido.coffee.autoconfigure.web.CoffeeErrorMvcAutoConfiguration,\
6 | site.zido.coffee.autoconfigure.web.RequestLogEnablerConfiguration
--------------------------------------------------------------------------------
/coffee-autoconfigures/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 |
6 | coffee-common-builder
7 | site.zido
8 | 0.3.0-SNAPSHOT
9 |
10 | 4.0.0
11 |
12 | coffee-autoconfigures
13 | pom
14 |
15 |
16 | coffee-autoconfigure-web
17 | coffee-autoconfigure-rest-security
18 | coffee-autoconfigure-extra
19 |
20 |
21 |
22 | site.zido
23 | coffee-autoconfigure-core
24 |
25 |
26 | org.springframework.boot
27 | spring-boot-configuration-processor
28 | true
29 |
30 |
31 | org.springframework.boot
32 | spring-boot-autoconfigure
33 |
34 |
35 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 |
6 | coffee-modules
7 | site.zido
8 | 0.3.0-SNAPSHOT
9 |
10 | 4.0.0
11 |
12 | coffee-core
13 |
14 |
15 |
16 | org.springframework
17 | spring-context
18 |
19 |
20 | javax.validation
21 | validation-api
22 | true
23 |
24 |
25 | net.jcip
26 | jcip-annotations
27 | 1.0
28 |
29 |
30 | org.junit.jupiter
31 | junit-jupiter-engine
32 |
33 |
34 | org.junit.platform
35 | junit-platform-runner
36 | test
37 |
38 |
39 | org.assertj
40 | assertj-core
41 | test
42 |
43 |
44 | org.mockito
45 | mockito-core
46 | test
47 |
48 |
49 | org.mockito
50 | mockito-junit-jupiter
51 | test
52 |
53 |
54 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/main/java/site/zido/coffee/core/Coffee.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core;
2 |
3 | public class Coffee {
4 | public static final String VERSION = "0.3.0-SNAPSHOT";
5 | }
6 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/main/java/site/zido/coffee/core/constants/Patterns.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.constants;
2 |
3 | public class Patterns {
4 | public static final String PHONE_PATTERN = "^1[123456789][\\d]{9}$";
5 | }
6 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/main/java/site/zido/coffee/core/message/CoffeeMessageSource.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.message;
2 |
3 | import org.springframework.context.support.MessageSourceAccessor;
4 | import org.springframework.context.support.ResourceBundleMessageSource;
5 |
6 | public class CoffeeMessageSource extends ResourceBundleMessageSource {
7 | public CoffeeMessageSource() {
8 | setBasename("spring.coffee.messages");
9 | }
10 |
11 | public static MessageSourceAccessor getAccessor() {
12 | return new MessageSourceAccessor(new CoffeeMessageSource());
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/main/java/site/zido/coffee/core/utils/BeanUtilsException.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.utils;
2 |
3 | /**
4 | * BeanUtils exception.
5 | *
6 | * @author zido
7 | */
8 | public class BeanUtilsException extends RuntimeException {
9 |
10 | public BeanUtilsException(String message) {
11 | super(message);
12 | }
13 |
14 | public BeanUtilsException(String message, Throwable cause) {
15 | super(message, cause);
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/main/java/site/zido/coffee/core/utils/InputConverter.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.utils;
2 |
3 | import org.springframework.lang.Nullable;
4 |
5 | import java.lang.reflect.ParameterizedType;
6 | import java.util.Objects;
7 |
8 | /**
9 | * 输入转换器接口，提供一个convertTo方法，转换到目标pojo
10 | *
11 | * 一般用于controller中传递对象转换到实际处理的entity或者pojo
12 | *
13 | * @param
14 | */
15 | public interface InputConverter {
16 |
17 | /**
18 | * Convert to domain.(shallow)
19 | *
20 | * @return new domain with same value(not null)
21 | */
22 | @SuppressWarnings("unchecked")
23 | default DOMAIN convertTo() {
24 | ParameterizedType currentType = parameterizedType();
25 |
26 | Objects.requireNonNull(currentType, "Cannot fetch actual type because parameterized type is null");
27 |
28 | Class domainClass = (Class) currentType.getActualTypeArguments()[0];
29 |
30 | return BeanUtils.transformFrom(this, domainClass);
31 | }
32 |
33 | default void update(DOMAIN domain) {
34 | BeanUtils.updateProperties(this, domain);
35 | }
36 |
37 | /**
38 | * Get parameterized type.
39 | *
40 | * @return parameterized type or null
41 | */
42 | @Nullable
43 | default ParameterizedType parameterizedType() {
44 | return ReflectionUtils.getParameterizedType(InputConverter.class, this.getClass());
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/main/java/site/zido/coffee/core/utils/OutputConverter.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.utils;
2 |
3 | import org.springframework.lang.NonNull;
4 |
5 | /**
6 | * 输出转换器接口，提供一个convertFrom方法，将pojo转换到其他对象
7 | *
8 | * 一般用于在逻辑处理完后返回DTO对象
9 | *
10 | * @param the implementation class type
11 | * @param domain type
12 | * @author zido
13 | */
14 | public interface OutputConverter, DOMAIN> {
15 |
16 | /**
17 | * Convert from domain.(shallow)
18 | *
19 | * @param domain domain data
20 | * @return converted dto data
21 | */
22 | @SuppressWarnings("unchecked")
23 | @NonNull
24 | default DTO convertFrom(@NonNull DOMAIN domain) {
25 |
26 | BeanUtils.updateProperties(domain, this);
27 |
28 | return (DTO) this;
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/main/java/site/zido/coffee/core/utils/RandomUtils.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.utils;
2 |
3 | import java.util.Random;
4 | import java.util.concurrent.ThreadLocalRandom;
5 |
6 | public final class RandomUtils {
7 |
8 | private RandomUtils() {
9 | }
10 |
11 | private static Random getRandom() {
12 | return ThreadLocalRandom.current();
13 | }
14 |
15 | public static String lowerStr(int len) {
16 | return str(len, 'a', 'z');
17 | }
18 |
19 | public static String upperStr(int len) {
20 | return str(len, 'A', 'Z');
21 | }
22 |
23 | public static String numeric(int len) {
24 | return str(len, '0', '9');
25 | }
26 |
27 | public static String ascii(int len) {
28 | return str(len, 32, 126);
29 | }
30 |
31 | public static String str(int len, int leftLimit, int rightLimit) {
32 | Random random = getRandom();
33 | return random.ints(leftLimit, rightLimit + 1)
34 | .limit(len)
35 | .collect(StringBuilder::new, StringBuilder::appendCodePoint, StringBuilder::append)
36 | .toString();
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/main/java/site/zido/coffee/core/utils/ReflectionUtils.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.utils;
2 |
3 | import org.springframework.lang.NonNull;
4 | import org.springframework.lang.Nullable;
5 | import org.springframework.util.Assert;
6 |
7 | import java.lang.reflect.ParameterizedType;
8 | import java.lang.reflect.Type;
9 |
10 | /**
11 | * Reflection utilities.
12 | *
13 | * @author zido
14 | */
15 | public class ReflectionUtils {
16 |
17 | private ReflectionUtils() {
18 | }
19 |
20 | /**
21 | * Gets parameterized type.
22 | *
23 | * @param superType super type must not be null (super class or super interface)
24 | * @param genericTypes generic type array
25 | * @return parameterized type of the interface or null if it is mismatch
26 | */
27 | @Nullable
28 | public static ParameterizedType getParameterizedType(@NonNull Class superType, Type... genericTypes) {
29 | Assert.notNull(superType, "Interface or super type must not be null");
30 |
31 | ParameterizedType currentType = null;
32 |
33 | for (Type genericType : genericTypes) {
34 | if (genericType instanceof ParameterizedType) {
35 | ParameterizedType parameterizedType = (ParameterizedType) genericType;
36 | if (parameterizedType.getRawType().getTypeName().equals(superType.getTypeName())) {
37 | currentType = parameterizedType;
38 | break;
39 | }
40 | }
41 | }
42 |
43 | return currentType;
44 | }
45 |
46 | /**
47 | * Gets parameterized type.
48 | *
49 | * @param interfaceType interface type must not be null
50 | * @param implementationClass implementation class of the interface must not be null
51 | * @return parameterized type of the interface or null if it is mismatch
52 | */
53 | @Nullable
54 | public static ParameterizedType getParameterizedType(@NonNull Class interfaceType, Class implementationClass) {
55 | Assert.notNull(interfaceType, "Interface type must not be null");
56 | Assert.isTrue(interfaceType.isInterface(), "The give type must be an interface");
57 |
58 | if (implementationClass == null) {
59 | // If the super class is Object parent then return null
60 | return null;
61 | }
62 |
63 | // Get parameterized type
64 | ParameterizedType currentType = getParameterizedType(interfaceType, implementationClass.getGenericInterfaces());
65 |
66 | if (currentType != null) {
67 | // return the current type
68 | return currentType;
69 | }
70 |
71 | Class superclass = implementationClass.getSuperclass();
72 |
73 | return getParameterizedType(interfaceType, superclass);
74 | }
75 |
76 | /**
77 | * Gets parameterized type by super class.
78 | *
79 | * @param superClassType super class type must not be null
80 | * @param extensionClass extension class
81 | * @return parameterized type or null
82 | */
83 | @Nullable
84 | public static ParameterizedType getParameterizedTypeBySuperClass(@NonNull Class superClassType, Class extensionClass) {
85 |
86 | if (extensionClass == null) {
87 | return null;
88 | }
89 |
90 | return getParameterizedType(superClassType, extensionClass.getGenericSuperclass());
91 | }
92 | }
93 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/main/java/site/zido/coffee/core/utils/SpringUtils.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.utils;
2 |
3 | import org.springframework.context.ApplicationContext;
4 |
5 | public final class SpringUtils {
6 | private SpringUtils() {
7 | }
8 |
9 | public static T getBeanOrNull(ApplicationContext context, Class type) {
10 | String[] userDetailsBeanNames = context.getBeanNamesForType(type);
11 | if (userDetailsBeanNames.length != 1) {
12 | return null;
13 | }
14 |
15 | return context.getBean(userDetailsBeanNames[0], type);
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/main/java/site/zido/coffee/core/utils/SystemClock.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.utils;
2 |
3 | import java.util.concurrent.ScheduledExecutorService;
4 | import java.util.concurrent.ScheduledThreadPoolExecutor;
5 | import java.util.concurrent.TimeUnit;
6 | import java.util.concurrent.atomic.AtomicLong;
7 |
8 | /**
9 | * 内存缓存的高并发适用钟摆
10 | *
11 | * @author zido
12 | */
13 | public class SystemClock {
14 | private final long period;
15 | private final AtomicLong now;
16 |
17 | private SystemClock(long period) {
18 | this.period = period;
19 | this.now = new AtomicLong(System.currentTimeMillis());
20 | scheduleClockUpdating();
21 | }
22 |
23 | private static SystemClock instance() {
24 | return InstanceHolder.INSTANCE;
25 | }
26 |
27 | /**
28 | * Now time millis.
29 | *
30 | * @return the long
31 | */
32 | public static long now() {
33 | return instance().currentTimeMillis();
34 | }
35 |
36 | private void scheduleClockUpdating() {
37 |
38 | ScheduledExecutorService scheduler = new ScheduledThreadPoolExecutor(1,
39 | r -> {
40 | Thread thread = new Thread(r, "System Clock");
41 | thread.setDaemon(true);
42 | return thread;
43 | });
44 | scheduler.scheduleAtFixedRate(() -> now.set(System.currentTimeMillis()), period, period, TimeUnit.MILLISECONDS);
45 | }
46 |
47 | private long currentTimeMillis() {
48 | return now.get();
49 | }
50 |
51 | private static class InstanceHolder {
52 | /**
53 | * The Instance.
54 | */
55 | static final SystemClock INSTANCE = new SystemClock(1);
56 | }
57 |
58 | }
59 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/main/java/site/zido/coffee/core/validations/Phone.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.validations;
2 |
3 |
4 | import javax.validation.Constraint;
5 | import javax.validation.Payload;
6 | import java.lang.annotation.*;
7 |
8 | /**
9 | * 手机号校验注解
10 | *
11 | * @author zido
12 | */
13 | @Target({ElementType.PARAMETER, ElementType.FIELD})
14 | @Documented
15 | @Retention(RetentionPolicy.RUNTIME)
16 | @Constraint(validatedBy = PhoneValidator.class)
17 | public @interface Phone {
18 | String message() default "手机号错误";
19 |
20 | Class[] groups() default {};
21 |
22 | Class[] payload() default {};
23 | }
24 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/main/java/site/zido/coffee/core/validations/PhoneValidator.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.validations;
2 |
3 |
4 | import javax.validation.ConstraintValidator;
5 | import javax.validation.ConstraintValidatorContext;
6 |
7 | import static site.zido.coffee.core.constants.Patterns.PHONE_PATTERN;
8 |
9 | /**
10 | * @author zido
11 | */
12 | public class PhoneValidator implements ConstraintValidator {
13 |
14 | @Override
15 | public void initialize(Phone constraintAnnotation) {
16 |
17 | }
18 |
19 | @Override
20 | public boolean isValid(String value, ConstraintValidatorContext context) {
21 | return value == null || (value.matches(PHONE_PATTERN));
22 | }
23 | }
24 |
25 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/test/java/site/zido/coffee/core/common/utils/ExpireMapTest.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.common.utils;
2 |
3 | import org.junit.jupiter.api.Assertions;
4 | import org.junit.jupiter.api.RepeatedTest;
5 | import site.zido.coffee.core.utils.maps.expire.ExpireMap;
6 |
7 | public class ExpireMapTest {
8 |
9 | @RepeatedTest(20)
10 | public void testTTL() {
11 | ExpireMap map = new ExpireMap<>();
12 | map.set("user", "1", 60 * 1000);
13 | long ttl = map.ttl("user");
14 | Assertions.assertTrue(ttl > 0, "返回超时时间应大于0且小于等于60000");
15 | Assertions.assertTrue(ttl <= 60 * 1000, "返回超时时间应小于等于60000");
16 | ttl = map.ttl("user");
17 | Assertions.assertTrue(ttl > 0, "第二次获取ttl，同样应返回超时时间应大于0且小于等于60000");
18 | Assertions.assertTrue(ttl <= 60 * 1000, "第二次获取ttl，同样应返回超时时间应小于等于60000");
19 | }
20 |
21 | @RepeatedTest(20)
22 | public void testTTLWhenForever() {
23 | ExpireMap map = new ExpireMap<>();
24 | map.set("user", "1");
25 | long ttl = map.ttl("user");
26 | Assertions.assertEquals(-1, ttl, "返回超时时间应为-1");
27 | ttl = map.ttl("user");
28 | Assertions.assertEquals(-1, ttl, "第二次操作返回超时时间应为-1");
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-core/src/test/java/site/zido/coffee/core/common/utils/SystemClockTest.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.core.common.utils;
2 |
3 | import org.junit.jupiter.api.Test;
4 | import site.zido.coffee.core.utils.SystemClock;
5 |
6 | import static org.assertj.core.api.Assertions.assertThat;
7 |
8 | public class SystemClockTest {
9 | @Test
10 | public void testClock() throws InterruptedException {
11 | long now = SystemClock.now();
12 | Thread.sleep(20);
13 | long last = SystemClock.now();
14 | assertThat(last).isNotEqualTo(now);
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 |
6 | coffee-modules
7 | site.zido
8 | 0.3.0-SNAPSHOT
9 |
10 | 4.0.0
11 |
12 | coffee-extra
13 |
14 | Some Tools For Coffee Spring Boot
15 |
16 |
17 |
18 | site.zido
19 | coffee-core
20 |
21 |
22 | com.github.kstyrc
23 | embedded-redis
24 | test
25 |
26 |
27 | redis.clients
28 | jedis
29 | test
30 |
31 |
32 | junit
33 | junit
34 | test
35 |
36 |
37 | org.mockito
38 | mockito-core
39 | test
40 |
41 |
42 | org.slf4j
43 | slf4j-simple
44 | test
45 |
46 |
47 | org.springframework.data
48 | spring-data-redis
49 | compile
50 | true
51 |
52 |
53 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/AbstractLimiterInvoker.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | /**
4 | * aop调用invoker
5 | *
6 | * @author zido
7 | */
8 | public class AbstractLimiterInvoker {
9 | private LimiterErrorHandler errorHandler;
10 |
11 | protected AbstractLimiterInvoker() {
12 | this(new SimpleLimiterErrorHandler());
13 | }
14 |
15 | protected AbstractLimiterInvoker(LimiterErrorHandler errorHandler) {
16 | this.errorHandler = errorHandler;
17 | }
18 |
19 | public LimiterErrorHandler getErrorHandler() {
20 | return errorHandler;
21 | }
22 |
23 | public void setErrorHandler(LimiterErrorHandler errorHandler) {
24 | this.errorHandler = errorHandler;
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/AbstractLimiterOperationSource.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import org.slf4j.Logger;
4 | import org.slf4j.LoggerFactory;
5 | import org.springframework.core.BridgeMethodResolver;
6 | import org.springframework.core.MethodClassKey;
7 | import org.springframework.util.ClassUtils;
8 |
9 | import java.lang.reflect.Method;
10 | import java.lang.reflect.Modifier;
11 | import java.util.Collection;
12 | import java.util.Collections;
13 | import java.util.Map;
14 | import java.util.concurrent.ConcurrentHashMap;
15 |
16 | /**
17 | * 注解扫描结果的缓存中心,包括类，方法
18 | *
19 | * @author zido
20 | */
21 | public abstract class AbstractLimiterOperationSource implements LimiterOperationSource {
22 | private final static Collection NULL_CACHING_ATTRIBUTE = Collections.emptyList();
23 | private final Logger logger = LoggerFactory.getLogger(getClass());
24 | private final Map> attributeCache = new ConcurrentHashMap<>(16);
25 |
26 | @Override
27 | public Collection getLimiterOperations(Method method, Class targetClass) {
28 | if (method.getDeclaringClass() == Object.class) {
29 | return null;
30 | }
31 | Object limiterKey = new MethodClassKey(method, targetClass);
32 | Collection cached = this.attributeCache.get(limiterKey);
33 | if (cached != null) {
34 | return (cached != NULL_CACHING_ATTRIBUTE ? cached : null);
35 | } else {
36 | Collection cacheOps = computeLimiterOperation(method, targetClass);
37 | if (cacheOps != null) {
38 | logger.debug("Adding limiter method '{}' with attribute: {}", method.getName(), cacheOps);
39 | this.attributeCache.put(limiterKey, cacheOps);
40 | } else {
41 | this.attributeCache.put(limiterKey, NULL_CACHING_ATTRIBUTE);
42 | }
43 | return cacheOps;
44 | }
45 | }
46 |
47 | private Collection computeLimiterOperation(Method method, Class targetClass) {
48 | if (allowPublicMethodsOnly() && !Modifier.isPublic(method.getModifiers())) {
49 | return null;
50 | }
51 | Method specMethod = ClassUtils.getMostSpecificMethod(method, targetClass);
52 | specMethod = BridgeMethodResolver.findBridgedMethod(specMethod);
53 | Collection opDef = resolve(specMethod, specMethod.getDeclaringClass());
54 | if (opDef != null) {
55 | return opDef;
56 | }
57 | if (specMethod != method) {
58 | return resolve(method, method.getDeclaringClass());
59 | }
60 | return null;
61 | }
62 |
63 | private Collection resolve(Method method, Class clazz) {
64 | Collection opDef = findLimiterOperations(method);
65 | if (opDef != null) {
66 | return opDef;
67 | }
68 | opDef = findLimiterOperations(clazz.getDeclaringClass());
69 | if (opDef != null && ClassUtils.isUserLevelMethod(method)) {
70 | return opDef;
71 | }
72 | return null;
73 | }
74 |
75 | protected abstract Collection findLimiterOperations(Method method);
76 |
77 | protected abstract Collection findLimiterOperations(Class clazz);
78 |
79 | protected boolean allowPublicMethodsOnly() {
80 | return false;
81 | }
82 | }
83 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/AnnotationDrivenLimiterBeanProcessor.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import org.springframework.aop.config.AopConfigUtils;
4 | import org.springframework.beans.factory.config.BeanDefinition;
5 | import org.springframework.beans.factory.support.BeanDefinitionRegistry;
6 | import org.springframework.beans.factory.support.RootBeanDefinition;
7 | import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
8 | import org.springframework.core.type.AnnotationMetadata;
9 |
10 | /**
11 | * 向容器中注入PointcutAdvisor切点{@link BeanFactoryLimiterOperationSourceAdvisor}
12 | *
13 | * @author zido
14 | */
15 | public class AnnotationDrivenLimiterBeanProcessor implements ImportBeanDefinitionRegistrar {
16 | private static final String LIMITER_ASPECT_CLASS_NAME = "site.zido.common.AnnotationLimiterAspect";
17 |
18 | @Override
19 | public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
20 | AopConfigUtils.registerAutoProxyCreatorIfNecessary(registry);
21 | RootBeanDefinition beanDefinition = new RootBeanDefinition(BeanFactoryLimiterOperationSourceAdvisor.class);
22 | //设置标识为服务
23 | beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
24 | registry.registerBeanDefinition(LIMITER_ASPECT_CLASS_NAME, beanDefinition);
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/AnnotationLimiterOperationSource.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import java.lang.reflect.Method;
4 | import java.util.ArrayList;
5 | import java.util.Collection;
6 | import java.util.LinkedHashSet;
7 | import java.util.Set;
8 |
9 | /**
10 | * 注解扫描执行
11 | *
12 | * @author zido
13 | */
14 | public class AnnotationLimiterOperationSource extends AbstractLimiterOperationSource {
15 | private final Set annotationParsers;
16 | private final boolean publicMethodsOnly;
17 |
18 | public AnnotationLimiterOperationSource() {
19 | this(true);
20 | }
21 |
22 | public AnnotationLimiterOperationSource(boolean publicMethodsOnly) {
23 | this.publicMethodsOnly = publicMethodsOnly;
24 | this.annotationParsers = new LinkedHashSet<>(1);
25 | this.annotationParsers.add(new SpringLimiterAnnotationParser());
26 | }
27 |
28 | @Override
29 | protected Collection findLimiterOperations(Method method) {
30 | return determine(parser -> parser.parseLimiterAnnotations(method));
31 | }
32 |
33 | @Override
34 | protected Collection findLimiterOperations(Class clazz) {
35 | return determine(parser -> parser.parseLimiterAnnotations(clazz));
36 | }
37 |
38 | protected Collection determine(LimiterOperationProvider provider) {
39 | ArrayList ops = null;
40 | for (LimiterAnnotationParser parser : annotationParsers) {
41 | Collection operations = provider.getLimiterOperations(parser);
42 | if (operations != null) {
43 | if (ops == null) {
44 | ops = new ArrayList<>();
45 | }
46 | ops.addAll(operations);
47 | }
48 | }
49 | return ops;
50 | }
51 |
52 | @Override
53 | protected boolean allowPublicMethodsOnly() {
54 | return this.publicMethodsOnly;
55 | }
56 |
57 | protected interface LimiterOperationProvider {
58 |
59 | /**
60 | * Return the {@link LimiterOperation} instance(s) provided by the specified parser.
61 | *
62 | * @param parser the parser to use
63 | * @return the cache operations, or {@code null} if none found
64 | */
65 | Collection getLimiterOperations(LimiterAnnotationParser parser);
66 | }
67 | }
68 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/BeanFactoryLimiterOperationSourceAdvisor.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import org.springframework.aop.Pointcut;
4 | import org.springframework.aop.support.AbstractBeanFactoryPointcutAdvisor;
5 | import org.springframework.aop.support.StaticMethodMatcherPointcut;
6 | import org.springframework.util.CollectionUtils;
7 |
8 | import java.lang.reflect.Method;
9 |
10 | /**
11 | * advisor
12 | *
13 | * @author zido
14 | */
15 | public class BeanFactoryLimiterOperationSourceAdvisor extends AbstractBeanFactoryPointcutAdvisor {
16 | private static final long serialVersionUID = 3093592396602137911L;
17 | private LimiterOperationSource limiterOperationSource;
18 | private final StaticMethodMatcherPointcut pointcut = new StaticMethodMatcherPointcut() {
19 | @Override
20 | public boolean matches(Method method, Class targetClass) {
21 | return (getLimiterOperationSource() != null
22 | && !CollectionUtils.isEmpty(getLimiterOperationSource().getLimiterOperations(method, targetClass)));
23 | }
24 | };
25 |
26 | @Override
27 | public Pointcut getPointcut() {
28 | return pointcut;
29 | }
30 |
31 | public LimiterOperationSource getLimiterOperationSource() {
32 | return limiterOperationSource;
33 | }
34 |
35 | public void setLimiterOperationSource(LimiterOperationSource limiterOperationSource) {
36 | this.limiterOperationSource = limiterOperationSource;
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/EnableLimiter.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import org.springframework.context.annotation.AdviceMode;
4 | import org.springframework.context.annotation.Import;
5 | import org.springframework.core.Ordered;
6 |
7 | import java.lang.annotation.*;
8 |
9 | /**
10 | * 启用limiter,与{@link org.springframework.cache.annotation.EnableCaching}类似
11 | * 可以选择是否使用cglib
12 | *
13 | * @author zido
14 | */
15 | @Target(ElementType.TYPE)
16 | @Retention(RetentionPolicy.RUNTIME)
17 | @Documented
18 | @Import(LimiterConfigurationSelector.class)
19 | public @interface EnableLimiter {
20 |
21 | /**
22 | * 是否强制使用cglib代理
23 | *
24 | * @return true/false
25 | */
26 | boolean proxyTargetClass() default false;
27 |
28 | /**
29 | * 选择代理模式
30 | */
31 | AdviceMode mode() default AdviceMode.PROXY;
32 |
33 | /**
34 | * 代理顺序
35 | */
36 | int order() default Ordered.LOWEST_PRECEDENCE;
37 | }
38 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/FrequencyLimiter.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | /**
4 | * 节点频率限制器，限制某个用户（key区分）的某个动作在特定时间内只能有一次
5 | *
6 | * 秒为单位
7 | *
8 | * @author zido
9 | */
10 | public interface FrequencyLimiter {
11 |
12 | /**
13 | * 尝试执行
14 | *
15 | * @param key key
16 | * @param timeout 设置如果本次拿到执行权的有效时间
17 | * @return 如果拿到了执行权则返回0，否则返回还需等待的时间
18 | */
19 | long tryGet(String key, long timeout);
20 | }
21 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/Limiter.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import java.lang.annotation.*;
4 | import java.util.concurrent.TimeUnit;
5 |
6 | /**
7 | * 限流器注解，可以根据任何资源进行限流{@link #key()}
8 | *
9 | * @author zido
10 | */
11 | @Target({ElementType.TYPE, ElementType.METHOD})
12 | @Retention(RetentionPolicy.RUNTIME)
13 | @Inherited
14 | @Documented
15 | public @interface Limiter {
16 | String key() default "";
17 |
18 | long timeout() default 55;
19 |
20 | TimeUnit unit() default TimeUnit.SECONDS;
21 | }
22 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/LimiterAnnotationParser.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import java.lang.reflect.Method;
4 | import java.util.Collection;
5 |
6 | /**
7 | * 注解解析器
8 | *
9 | * @author zido
10 | */
11 | public interface LimiterAnnotationParser {
12 | Collection parseLimiterAnnotations(Class type);
13 |
14 | Collection parseLimiterAnnotations(Method method);
15 | }
16 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/LimiterConfigurationSelector.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import org.springframework.context.annotation.AdviceMode;
4 | import org.springframework.context.annotation.AdviceModeImportSelector;
5 | import org.springframework.context.annotation.AutoProxyRegistrar;
6 |
7 | public class LimiterConfigurationSelector extends AdviceModeImportSelector {
8 | @Override
9 | protected String[] selectImports(AdviceMode adviceMode) {
10 | return new String[]{
11 | AutoProxyRegistrar.class.getName(),
12 | ProxyLimiterConfiguration.class.getName()
13 | };
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/LimiterErrorHandler.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | /**
4 | * 异常处理器
5 | *
6 | * @author zido
7 | */
8 | public interface LimiterErrorHandler {
9 | /**
10 | * 处理通用异常
11 | *
12 | * @param exception exception
13 | * @param key 注解的key
14 | */
15 | void handleError(RuntimeException exception, Object key);
16 |
17 | /**
18 | * 被限流时的处理
19 | *
20 | * @param exception exception
21 | */
22 | void handleOnLimited(LimiterException exception);
23 | }
24 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/LimiterException.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | /**
4 | * 当方法调用频率被限制时，抛出的异常
5 | *
6 | * @author zido
7 | * @see LimiterErrorHandler
8 | * @see FrequencyLimiter
9 | */
10 | public class LimiterException extends RuntimeException {
11 | private static final long serialVersionUID = -8703559654766706392L;
12 | /**
13 | * 限制的key
14 | */
15 | private Object key;
16 | /**
17 | * 剩余时间
18 | */
19 | private long last;
20 | /**
21 | * 下次需要的时间
22 | */
23 | private long requireTime;
24 |
25 | public LimiterException() {
26 |
27 | }
28 |
29 | public LimiterException(Object key, long last, long requireTime) {
30 | super(String.format("频率过高，请在 %d 秒后重试", last));
31 | this.key = key;
32 | this.last = last;
33 | this.requireTime = requireTime;
34 | }
35 |
36 | public Object getKey() {
37 | return key;
38 | }
39 |
40 | public long getLast() {
41 | return last;
42 | }
43 |
44 | public long getRequireTime() {
45 | return requireTime;
46 | }
47 |
48 | public void setKey(Object key) {
49 | this.key = key;
50 | }
51 |
52 | public void setLast(long last) {
53 | this.last = last;
54 | }
55 |
56 | public void setRequireTime(long requireTime) {
57 | this.requireTime = requireTime;
58 | }
59 | }
60 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/LimiterOperation.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import java.util.concurrent.TimeUnit;
4 |
5 | public class LimiterOperation {
6 | private final String key;
7 | private final long timeout;
8 | private final TimeUnit unit;
9 | private final String name;
10 |
11 | public LimiterOperation(Builder builder) {
12 | this.key = builder.getKey();
13 | this.timeout = builder.getTimeout();
14 | this.unit = builder.getUnit();
15 | name = builder.getName();
16 | }
17 |
18 | public String getKey() {
19 | return key;
20 | }
21 |
22 | public long getTimeout() {
23 | return timeout;
24 | }
25 |
26 | public TimeUnit getUnit() {
27 | return unit;
28 | }
29 |
30 | public String getName() {
31 | return name;
32 | }
33 |
34 | public static class Builder {
35 | private String key = "";
36 | private long timeout = 55;
37 | private TimeUnit unit = TimeUnit.SECONDS;
38 | private String name = "";
39 |
40 | public String getKey() {
41 | return key;
42 | }
43 |
44 | public void setKey(String key) {
45 | this.key = key;
46 | }
47 |
48 | public long getTimeout() {
49 | return timeout;
50 | }
51 |
52 | public void setTimeout(long timeout) {
53 | this.timeout = timeout;
54 | }
55 |
56 | public TimeUnit getUnit() {
57 | return unit;
58 | }
59 |
60 | public void setUnit(TimeUnit unit) {
61 | this.unit = unit;
62 | }
63 |
64 |
65 | public LimiterOperation build() {
66 | return new LimiterOperation(this);
67 | }
68 |
69 | public String getName() {
70 | return name;
71 | }
72 |
73 | public void setName(String name) {
74 | this.name = name;
75 | }
76 | }
77 | }
78 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/LimiterOperationSource.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import java.lang.reflect.Method;
4 | import java.util.Collection;
5 |
6 | public interface LimiterOperationSource {
7 | Collection getLimiterOperations(Method method, Class targetClass);
8 | }
9 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/LimiterRootObject.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import java.lang.reflect.Method;
4 |
5 | public class LimiterRootObject {
6 |
7 | private final Method method;
8 |
9 | private final Object[] args;
10 |
11 | private final Object target;
12 |
13 | private final Class targetClass;
14 |
15 | public LimiterRootObject(Method method, Object[] args, Object target, Class targetClass) {
16 | this.method = method;
17 | this.args = args;
18 | this.target = target;
19 | this.targetClass = targetClass;
20 | }
21 |
22 | public Method getMethod() {
23 | return method;
24 | }
25 |
26 | public Object[] getArgs() {
27 | return args;
28 | }
29 |
30 | public Object getTarget() {
31 | return target;
32 | }
33 |
34 | public Class getTargetClass() {
35 | return targetClass;
36 | }
37 | }
38 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/MemoryFrequencyLimiter.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import site.zido.coffee.core.utils.maps.expire.ExpireMap;
4 |
5 | /**
6 | * 基于内存的频率限制
7 | *
8 | * @author zido
9 | */
10 | public class MemoryFrequencyLimiter implements FrequencyLimiter {
11 | private static final Object PRESENT = new Object();
12 | private ExpireMap expireMap = new ExpireMap<>();
13 | private String prefix = "";
14 |
15 | public MemoryFrequencyLimiter() {
16 |
17 | }
18 |
19 | public MemoryFrequencyLimiter(String prefix) {
20 | this.prefix = prefix;
21 | }
22 |
23 | @Override
24 | public long tryGet(String key, long timeout) {
25 | key = getKey(key);
26 |
27 | if (expireMap.setNx(key, PRESENT, timeout)) {
28 | return 0;
29 | }
30 | long ttl = expireMap.ttl(key);
31 | if (ttl == -1) {
32 | throw new IllegalStateException(String.format("key:%s永久存在，无法获取执行", key));
33 | }
34 | return ttl;
35 | }
36 |
37 | protected String getKey(String key) {
38 | return prefix + key;
39 | }
40 |
41 | public void setExpireMap(ExpireMap expireMap) {
42 | this.expireMap = expireMap;
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/ProxyLimiterConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import org.springframework.beans.factory.config.BeanDefinition;
4 | import org.springframework.context.annotation.Bean;
5 | import org.springframework.context.annotation.Configuration;
6 | import org.springframework.context.annotation.Role;
7 |
8 | /**
9 | * @author zido
10 | */
11 | @Configuration
12 | @Role(BeanDefinition.ROLE_INFRASTRUCTURE)
13 | public class ProxyLimiterConfiguration {
14 | @Bean
15 | @Role(BeanDefinition.ROLE_INFRASTRUCTURE)
16 | public BeanFactoryLimiterOperationSourceAdvisor limiterAdvisor(LimiterInterceptor interceptor) {
17 | BeanFactoryLimiterOperationSourceAdvisor advisor = new BeanFactoryLimiterOperationSourceAdvisor();
18 | advisor.setAdvice(interceptor);
19 | advisor.setLimiterOperationSource(limiterOperationSource());
20 | return advisor;
21 | }
22 |
23 | @Bean
24 | @Role(BeanDefinition.ROLE_INFRASTRUCTURE)
25 | public LimiterOperationSource limiterOperationSource() {
26 | return new AnnotationLimiterOperationSource();
27 | }
28 |
29 | @Bean
30 | @Role(BeanDefinition.ROLE_INFRASTRUCTURE)
31 | public LimiterInterceptor interceptor(FrequencyLimiter limiter) {
32 | LimiterInterceptor interceptor = new LimiterInterceptor();
33 | interceptor.setLimiterOperationSource(limiterOperationSource());
34 | interceptor.setLimiter(limiter);
35 | return interceptor;
36 | }
37 | }
38 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/ProxyLimiterConfigurer.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | /**
4 | * limiter配置
5 | */
6 | public interface ProxyLimiterConfigurer {
7 | FrequencyLimiter limiter();
8 | }
9 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/RedisFrequencyLimiter.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import org.springframework.data.redis.core.RedisTemplate;
4 | import org.springframework.util.Assert;
5 | import site.zido.coffee.core.utils.SystemClock;
6 |
7 | import java.util.concurrent.TimeUnit;
8 |
9 | /**
10 | * 基于redis的频率限制器
11 | *
12 | * 使用场景：手机号发送短信验证码一分钟不能超过一次(建议时间设置比实际情况略小
13 | *
14 | * @author zido
15 | */
16 | public class RedisFrequencyLimiter implements FrequencyLimiter {
17 |
18 | private static final String PRE = "coffee:limiter:";
19 | private final String prefix;
20 | private final RedisTemplate template;
21 |
22 | public RedisFrequencyLimiter(String prefix, RedisTemplate template) {
23 | this.prefix = prefix;
24 | this.template = template;
25 | }
26 |
27 | public RedisFrequencyLimiter(RedisTemplate template) {
28 | this(PRE, template);
29 | }
30 |
31 | @Override
32 | public long tryGet(String key, long timeout) {
33 | Assert.isTrue(timeout > 1, "超时时间设定以秒为单位，并且需要大于一秒");
34 | Assert.isTrue(timeout <= Integer.MAX_VALUE, "超时时间需要小于等于" + Integer.MAX_VALUE);
35 | long now = SystemClock.now();
36 | now = now / 1000;
37 | String prefixedKey = prefix + key;
38 | Long expire = template.getExpire(prefixedKey, TimeUnit.MILLISECONDS);
39 | //redis集群可能无法准确过期，用ttl判断更准确
40 | if (expire != null) {
41 | //如果值永久有效将永远无法有效获取
42 | if (expire == -1) {
43 | throw new IllegalStateException(String.format("键[%s]永久有效，需要排查", prefixedKey));
44 | }
45 | if (expire > 0) {
46 | return expire;
47 | }
48 | }
49 | createTag(key, now, timeout);
50 | return 0;
51 | }
52 |
53 | private void createTag(String key, long date, long timeout) {
54 | template.opsForValue().set(prefix + key, date, timeout);
55 | }
56 | }
57 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/SimpleLimiterErrorHandler.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | /**
4 | * @author zido
5 | */
6 | public class SimpleLimiterErrorHandler implements LimiterErrorHandler {
7 | @Override
8 | public void handleError(RuntimeException exception, Object key) {
9 | throw exception;
10 | }
11 |
12 | @Override
13 | public void handleOnLimited(LimiterException exception) {
14 | throw exception;
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/limiter/SpringLimiterAnnotationParser.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.limiter;
2 |
3 | import org.springframework.core.annotation.AnnotatedElementUtils;
4 |
5 | import java.lang.reflect.AnnotatedElement;
6 | import java.lang.reflect.Method;
7 | import java.util.ArrayList;
8 | import java.util.Collection;
9 |
10 | /**
11 | * 限流器注解解析器,负责解析限流器，以提供注解式限流支持
12 | *
13 | * @author zido
14 | * @see Limiter
15 | */
16 | public class SpringLimiterAnnotationParser implements LimiterAnnotationParser {
17 |
18 | /**
19 | * 解析类上注解
20 | *
21 | * @param type target class type
22 | * @return operations
23 | */
24 | @Override
25 | public Collection parseLimiterAnnotations(Class type) {
26 | return parse(type);
27 | }
28 |
29 | /**
30 | * 解析方法上的注解
31 | *
32 | * @param method target method
33 | * @return operations
34 | */
35 | @Override
36 | public Collection parseLimiterAnnotations(Method method) {
37 | return parse(method);
38 | }
39 |
40 | protected Collection parse(AnnotatedElement ae) {
41 | Collection ops = new ArrayList<>(1);
42 |
43 | Collection limiters = AnnotatedElementUtils.getAllMergedAnnotations(ae, Limiter.class);
44 | if (!limiters.isEmpty()) {
45 | for (Limiter limiter : limiters) {
46 | ops.add(parseLimiterAnnotation(ae, limiter));
47 | }
48 | }
49 | return ops;
50 | }
51 |
52 | private LimiterOperation parseLimiterAnnotation(AnnotatedElement ae, Limiter limiter) {
53 | LimiterOperation.Builder builder = new LimiterOperation.Builder();
54 | builder.setName(ae.toString());
55 | builder.setKey(limiter.key());
56 | builder.setTimeout(limiter.timeout());
57 | builder.setUnit(limiter.unit());
58 | return builder.build();
59 | }
60 |
61 | @Override
62 | public boolean equals(Object other) {
63 | return other instanceof SpringLimiterAnnotationParser;
64 | }
65 |
66 | @Override
67 | public int hashCode() {
68 | return SpringLimiterAnnotationParser.class.hashCode();
69 | }
70 | }
71 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/lock/DistributedLockFactory.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.lock;
2 |
3 | import org.springframework.data.redis.connection.RedisConnectionFactory;
4 | import org.springframework.util.Assert;
5 |
6 | import java.nio.charset.Charset;
7 | import java.util.Map;
8 | import java.util.Objects;
9 | import java.util.concurrent.ConcurrentHashMap;
10 | import java.util.concurrent.TimeUnit;
11 | import java.util.concurrent.locks.Lock;
12 |
13 | public class DistributedLockFactory {
14 | private Map lockCache = new ConcurrentHashMap<>();
15 | private RedisConnectionFactory redisConnectionFactory;
16 | private Charset charset;
17 |
18 | public RedisConnectionFactory getRedisConnectionFactory() {
19 | return redisConnectionFactory;
20 | }
21 |
22 | public void setRedisConnectionFactory(RedisConnectionFactory redisConnectionFactory) {
23 | this.redisConnectionFactory = redisConnectionFactory;
24 | }
25 |
26 | public Charset getCharset() {
27 | return charset;
28 | }
29 |
30 | public void setCharset(Charset charset) {
31 | this.charset = charset;
32 | }
33 |
34 | public Lock getLock(String key, long timeout, TimeUnit unit) {
35 | return lockCache.computeIfAbsent(new MultiKey(key, timeout, unit), multiKey -> new DistributedRedisLock(key, redisConnectionFactory, timeout, unit));
36 | }
37 |
38 | static class MultiKey {
39 | private String key;
40 | private long timeout;
41 | private TimeUnit unit;
42 |
43 | MultiKey(String key, long timeout, TimeUnit unit) {
44 | Assert.hasLength(key, "lock key can't be null or empty");
45 | Assert.state(timeout > 0, "超时时间还必须大于0");
46 | this.key = key;
47 | this.timeout = timeout;
48 | this.unit = unit;
49 | }
50 |
51 | @Override
52 | public boolean equals(Object o) {
53 | if (this == o) {
54 | return true;
55 | }
56 | if (o == null || getClass() != o.getClass()) {
57 | return false;
58 | }
59 | MultiKey multiKey = (MultiKey) o;
60 | return timeout == multiKey.timeout &&
61 | Objects.equals(key, multiKey.key) &&
62 | unit == multiKey.unit;
63 | }
64 |
65 | @Override
66 | public int hashCode() {
67 | return Objects.hash(key, timeout, unit);
68 | }
69 | }
70 | }
71 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/package-info.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra;
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/security/AbstractSecurity.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.security;
2 |
3 |
4 | import java.nio.charset.Charset;
5 | import java.security.MessageDigest;
6 | import java.security.NoSuchAlgorithmException;
7 | import java.util.Arrays;
8 | import java.util.concurrent.TimeUnit;
9 |
10 | /**
11 | * 防重放攻击解决方案
12 | *
13 | * @author zido
14 | */
15 | public abstract class AbstractSecurity {
16 | private static final String[] HEX_DIG_ITS = {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "a", "b", "c", "d", "e", "f"};
17 | private static Charset defaultCharset = Charset.forName("utf-8");
18 | private String token;
19 | private long timeDifference = TimeUnit.MINUTES.toMillis(1);
20 | private long lastModifyTime = System.currentTimeMillis();
21 |
22 | public AbstractSecurity(String token) {
23 | this.token = token;
24 | }
25 |
26 | private static String bytesToStr(byte[] bytes) {
27 | StringBuilder sb = new StringBuilder();
28 | for (byte b : bytes) {
29 | sb.append(byteToHex(b));
30 | }
31 | return sb.toString();
32 | }
33 |
34 | private static String byteToHex(byte b) {
35 | int n = (int) b;
36 | if (n < 0) {
37 | n += 256;
38 | }
39 | final int div = n / 16;
40 | final int mod = n % 16;
41 | return HEX_DIG_ITS[div] + HEX_DIG_ITS[mod];
42 | }
43 |
44 | /**
45 | * 校验签名
46 | *
47 | * @param timeStamp 时间戳
48 | * @param sign 签名串
49 | * @param params 待验证的参数
50 | * @return 是否验证通过
51 | */
52 | public boolean validate(long timeStamp, String sign, Object... params) {
53 | return encode(timeStamp, params).equalsIgnoreCase(sign);
54 | }
55 |
56 | /**
57 | * 检测重放
58 | *
59 | * @param nonce nonce字段
60 | * @param timestamp 时间戳
61 | * @return false为重复/超时的请求，true为合理请求
62 | */
63 | public boolean checkNonce(Object nonce, long timestamp) {
64 | long currentTimeMillis = System.currentTimeMillis();
65 | //判断请求是否超时
66 | if (currentTimeMillis - timestamp > timeDifference) {
67 | return false;
68 | }
69 | //清空60s前的nonce集合
70 | if (currentTimeMillis - lastModifyTime > timeDifference) {
71 | clearNonce();
72 | }
73 | //判断nonce是否存在
74 | if (addNonce(timestamp + "" + nonce)) {
75 | lastModifyTime = currentTimeMillis;
76 | return true;
77 | }
78 | return false;
79 | }
80 |
81 | protected abstract void clearNonce();
82 |
83 | protected abstract boolean addNonce(String nonce);
84 |
85 | /**
86 | * 加密数据
87 | *
88 | * @param timeStamp 时间戳
89 | * @param params 参数
90 | * @return 加密串
91 | */
92 | public String encode(long timeStamp, Object... params) {
93 | String originValue = token + handleParams(params) + timeStamp + token;
94 | byte[] secretBytes;
95 | try {
96 | secretBytes = MessageDigest.getInstance("md5").digest(
97 | originValue.getBytes(defaultCharset));
98 | } catch (NoSuchAlgorithmException e) {
99 | throw new RuntimeException(e);
100 | }
101 | return bytesToStr(secretBytes);
102 | }
103 |
104 | private String handleParams(Object... params) {
105 | return Arrays.stream(params)
106 | .map(Object::toString)
107 | .sorted()
108 | .reduce((String target, String current) -> target + current)
109 | .orElseThrow(() -> new IllegalArgumentException("params error"));
110 | }
111 |
112 | public void setTimeDifference(long timeDifference) {
113 | this.timeDifference = timeDifference;
114 | }
115 | }
116 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/main/java/site/zido/coffee/extra/security/StringRedisTemplateSecurity.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.extra.security;
2 |
3 | import org.springframework.data.redis.core.StringRedisTemplate;
4 |
5 | /**
6 | * 可以直接注入使用
7 | *
8 | * 注意不同的业务（例如对接网易与对接其他第三方接口），
9 | * 在注入bean的时候，记得使用命名bean或者可以直接继承实现，注入下一层的bean
10 | *
11 | * @author zido
12 | */
13 | public class StringRedisTemplateSecurity extends AbstractSecurity {
14 |
15 | private String nonceKey;
16 | private StringRedisTemplate template;
17 |
18 | public StringRedisTemplateSecurity(String token, String nonceKey, StringRedisTemplate template) {
19 | super(token);
20 | this.nonceKey = nonceKey;
21 | this.template = template;
22 | }
23 |
24 | @Override
25 | protected void clearNonce() {
26 | template.delete(nonceKey);
27 | }
28 |
29 | @Override
30 | protected boolean addNonce(String nonce) {
31 | return 1 == template.opsForSet().add(nonceKey, nonce);
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-extra/src/test/java/limiter/MemoryFrequencyLimiterTest.java:
--------------------------------------------------------------------------------
1 | package limiter;
2 |
3 | import org.junit.jupiter.api.Assertions;
4 | import org.junit.jupiter.api.Test;
5 | import site.zido.coffee.core.utils.maps.expire.ExpireMap;
6 | import site.zido.coffee.extra.limiter.MemoryFrequencyLimiter;
7 |
8 | import static org.mockito.ArgumentMatchers.any;
9 | import static org.mockito.ArgumentMatchers.eq;
10 | import static org.mockito.Mockito.*;
11 |
12 | public class MemoryFrequencyLimiterTest {
13 | @Test
14 | public void testWhenTimeoutIsEqual() throws InterruptedException {
15 | @SuppressWarnings("unchecked") ExpireMap expireMap = mock(ExpireMap.class);
16 | MemoryFrequencyLimiter limiter = new MemoryFrequencyLimiter();
17 | limiter.setExpireMap(expireMap);
18 | //当第一次设置必定成功
19 | when(expireMap.setNx(eq("test"), any(), eq(1L))).thenReturn(true);
20 | long test = limiter.tryGet("test", 1);
21 | verify(expireMap, never()).ttl(any());
22 | Assertions.assertEquals(0L, test);
23 | //第二次设置时，因key已存在，则必定失败
24 | when(expireMap.setNx(eq("test"), any(), eq(1L))).thenReturn(false);
25 | when(expireMap.ttl("test")).thenReturn(1L);
26 | long last = limiter.tryGet("test", 1);
27 | Assertions.assertEquals(1L, last);
28 | }
29 |
30 | @Test
31 | public void testWhenTimeoutIsNotEqual() throws InterruptedException {
32 | @SuppressWarnings("unchecked") ExpireMap expireMap = mock(ExpireMap.class);
33 | MemoryFrequencyLimiter limiter = new MemoryFrequencyLimiter();
34 | limiter.setExpireMap(expireMap);
35 | when(expireMap.setNx(eq("test"), any(), eq(1L))).thenReturn(true);
36 | long test = limiter.tryGet("test", 1);
37 | verify(expireMap, never()).ttl(any());
38 | Assertions.assertEquals(0L, test);
39 | when(expireMap.setNx(eq("test"), any(), eq(2L))).thenReturn(false);
40 | when(expireMap.ttl("test")).thenReturn(1L);
41 | long last = limiter.tryGet("test", 2);
42 | Assertions.assertEquals(1, last);
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 |
6 | coffee-modules
7 | site.zido
8 | 0.3.0-SNAPSHOT
9 |
10 | 4.0.0
11 |
12 | coffee-rest-security
13 |
14 |
15 |
16 | site.zido
17 | coffee-core
18 |
19 |
20 | site.zido
21 | coffee-extra
22 | true
23 |
24 |
25 | site.zido
26 | coffee-webmvc
27 |
28 |
29 | org.springframework.security
30 | spring-security-web
31 |
32 |
33 | org.springframework.security
34 | spring-security-config
35 |
36 |
37 | org.springframework.boot
38 | spring-boot-starter-test
39 | test
40 |
41 |
42 | org.springframework
43 | spring-webmvc
44 |
45 |
46 | javax.servlet
47 | servlet-api
48 | 2.3
49 | provided
50 |
51 |
52 | io.jsonwebtoken
53 | jjwt
54 |
55 |
56 | org.springframework.data
57 | spring-data-redis
58 | provided
59 |
60 |
61 |
62 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/authentication/RestAuthenticationFailureHandler.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.authentication;
2 |
3 | import org.springframework.http.MediaType;
4 | import org.springframework.security.core.AuthenticationException;
5 | import org.springframework.security.web.authentication.AuthenticationFailureHandler;
6 | import org.springframework.util.StringUtils;
7 |
8 | import javax.servlet.ServletException;
9 | import javax.servlet.http.HttpServletRequest;
10 | import javax.servlet.http.HttpServletResponse;
11 | import java.io.IOException;
12 |
13 | /**
14 | * @author zido
15 | */
16 | public class RestAuthenticationFailureHandler implements AuthenticationFailureHandler {
17 | private MediaType mediaType;
18 | private String successBody;
19 |
20 | public RestAuthenticationFailureHandler() {
21 | }
22 |
23 | public RestAuthenticationFailureHandler(String successBody) {
24 | this(MediaType.APPLICATION_JSON, successBody);
25 | }
26 |
27 | public RestAuthenticationFailureHandler(MediaType mediaType, String successBody) {
28 | this.mediaType = mediaType;
29 | this.successBody = successBody;
30 | }
31 |
32 | public void setMediaType(MediaType mediaType) {
33 | this.mediaType = mediaType;
34 | }
35 |
36 | public void setSuccessBody(String successBody) {
37 | this.successBody = successBody;
38 | }
39 |
40 | @Override
41 | public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception) throws IOException, ServletException {
42 | response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
43 | if (this.mediaType != null) {
44 | response.setHeader("Content-Type", this.mediaType.toString());
45 | }
46 | if (StringUtils.hasLength(successBody)) {
47 | response.getWriter().write(successBody);
48 | }
49 | }
50 | }
51 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/authentication/RestAuthenticationSuccessHandler.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.authentication;
2 |
3 | import org.springframework.http.MediaType;
4 | import org.springframework.security.core.Authentication;
5 | import org.springframework.security.web.authentication.AuthenticationSuccessHandler;
6 | import org.springframework.util.StringUtils;
7 |
8 | import javax.servlet.ServletException;
9 | import javax.servlet.http.HttpServletRequest;
10 | import javax.servlet.http.HttpServletResponse;
11 | import java.io.IOException;
12 |
13 | /**
14 | * @author zido
15 | */
16 | public class RestAuthenticationSuccessHandler implements
17 | AuthenticationSuccessHandler {
18 | private MediaType mediaType;
19 | private String successBody;
20 |
21 | public RestAuthenticationSuccessHandler() {
22 | }
23 |
24 | public RestAuthenticationSuccessHandler(String successBody) {
25 | this(MediaType.APPLICATION_JSON, successBody);
26 | }
27 |
28 | public RestAuthenticationSuccessHandler(MediaType mediaType, String successBody) {
29 | this.mediaType = mediaType;
30 | this.successBody = successBody;
31 | }
32 |
33 | @Override
34 | public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication) throws IOException, ServletException {
35 | if (this.mediaType != null) {
36 | response.setHeader("Content-Type", this.mediaType.toString());
37 | }
38 | if (StringUtils.hasLength(successBody)) {
39 | response.getWriter().write(successBody);
40 | }
41 | }
42 |
43 | public void setMediaType(MediaType mediaType) {
44 | this.mediaType = mediaType;
45 | }
46 |
47 | public void setSuccessBody(String successBody) {
48 | this.successBody = successBody;
49 | }
50 | }
51 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/authentication/phone/CodeGenerator.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.authentication.phone;
2 |
3 | /**
4 | * 验证码生成器
5 | *
6 | * @author zido
7 | */
8 | public interface CodeGenerator {
9 | /**
10 | * 生成验证码
11 | *
12 | * @param phone 手机号
13 | * @return code
14 | */
15 | String generateCode(String phone);
16 | }
17 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/authentication/phone/CodeValidator.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.authentication.phone;
2 |
3 | /**
4 | * 验证码比对
5 | *
6 | * @author zido
7 | */
8 | public interface CodeValidator {
9 |
10 | /**
11 | * 验证code
12 | *
13 | * @param originalCode 原code
14 | * @param inputCode 输入的code
15 | * @return true/false
16 | */
17 | boolean validate(String originalCode, String inputCode);
18 |
19 | }
20 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/authentication/phone/CustomCodeGenerator.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.authentication.phone;
2 |
3 | import io.jsonwebtoken.lang.Assert;
4 | import org.springframework.beans.factory.InitializingBean;
5 |
6 | import java.util.ArrayList;
7 | import java.util.List;
8 | import java.util.Random;
9 |
10 | /**
11 | * 默认验证码生成器
12 | *
13 | * 具有一定可自定义功能,例如可控的动态长度，字符/数组组合
14 | *
15 | * @author zido
16 | */
17 | public class CustomCodeGenerator implements CodeGenerator, InitializingBean {
18 | private static final char[] ARR_NUMBER = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9'};
19 | private static final char[] ARR_LOWER_CHAR = {'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j',
20 | 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z'};
21 | private static final char[] ARR_UPPER_CHAR = {'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J',
22 | 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z'};
23 | private int minLength = 6;
24 | private int maxLength = 6;
25 | private final List arr = new ArrayList<>();
26 | private final Random random = new Random();
27 |
28 | public CustomCodeGenerator(Mode... modes) {
29 | if (modes == null || modes.length == 0) {
30 | this.setMode(Mode.NUMBER);
31 | } else {
32 | this.setMode(modes);
33 | }
34 | }
35 |
36 | @Override
37 | public String generateCode(String phone) {
38 | StringBuilder sb = new StringBuilder();
39 | for (int i = 0; i < maxLength; i++) {
40 | int index = random.nextInt(arr.size());
41 | sb.append(arr.get(index));
42 | if (sb.length() >= minLength) {
43 | if (random.nextBoolean()) {
44 | break;
45 | }
46 | }
47 | }
48 | return sb.toString();
49 | }
50 |
51 | public void setMode(Mode... modes) {
52 | this.arr.clear();
53 | addMode(modes);
54 | }
55 |
56 | public void addMode(Mode... modes) {
57 | if (modes != null && modes.length > 0) {
58 | for (Mode mode : modes) {
59 | switch (mode) {
60 | case NUMBER:
61 | addArr(ARR_NUMBER);
62 | break;
63 | case LOWER_CHAR:
64 | addArr(ARR_LOWER_CHAR);
65 | break;
66 | case UPPER_CHAR:
67 | addArr(ARR_UPPER_CHAR);
68 | break;
69 | default:
70 | throw new IllegalStateException("unreachable");
71 | }
72 | }
73 | }
74 | }
75 |
76 | public void addArr(char[] chars) {
77 | for (char c : chars) {
78 | this.arr.add(c);
79 | }
80 | }
81 |
82 | public void setMinLength(int minLength) {
83 | this.minLength = minLength;
84 | }
85 |
86 | public void setMaxLength(int maxLength) {
87 | this.maxLength = maxLength;
88 | }
89 |
90 | @Override
91 | public void afterPropertiesSet() throws Exception {
92 | Assert.notEmpty(this.arr, "char array cannot be empty");
93 | }
94 |
95 | /**
96 | * 验证码生成模式
97 | */
98 | public enum Mode {
99 | /**
100 | * 数组
101 | */
102 | NUMBER,
103 | /**
104 | * 字符
105 | */
106 | LOWER_CHAR,
107 | /**
108 | * 字符加数字
109 | */
110 | UPPER_CHAR,
111 | }
112 | }
113 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/authentication/phone/CustomCodeValidator.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.authentication.phone;
2 |
3 | import java.util.Objects;
4 |
5 | /**
6 | * @author zido
7 | */
8 | public class CustomCodeValidator implements CodeValidator {
9 | private boolean ignoreCase;
10 |
11 | public CustomCodeValidator() {
12 | this(true);
13 | }
14 |
15 | public CustomCodeValidator(boolean ignoreCase) {
16 | this.ignoreCase = ignoreCase;
17 | }
18 |
19 | @Override
20 | public boolean validate(String originalCode, String inputCode) {
21 | return ignoreCase ? (originalCode != null && originalCode.equalsIgnoreCase(inputCode)) : Objects.equals(originalCode, inputCode);
22 | }
23 |
24 | public void setIgnoreCase(boolean ignoreCase) {
25 | this.ignoreCase = ignoreCase;
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/authentication/phone/MemoryPhoneCodeCache.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.authentication.phone;
2 |
3 | import site.zido.coffee.core.utils.maps.expire.ExpireMap;
4 |
5 | import java.util.concurrent.TimeUnit;
6 |
7 | public class MemoryPhoneCodeCache implements PhoneCodeCache {
8 | private final ExpireMap expireMap;
9 | private long timeout = 60;
10 |
11 | public MemoryPhoneCodeCache() {
12 | this(new ExpireMap<>(1, TimeUnit.MINUTES));
13 | }
14 |
15 | public MemoryPhoneCodeCache(ExpireMap expireMap) {
16 | this.expireMap = expireMap;
17 | }
18 |
19 | @Override
20 | public void put(String phone, String code) {
21 | expireMap.set(phone, code, timeout * 1000);
22 | }
23 |
24 | @Override
25 | public String getCode(String phone) {
26 | return expireMap.get(phone);
27 | }
28 |
29 | public void setTimeout(long timeout) {
30 | this.timeout = timeout;
31 | }
32 |
33 | public long getTimeout() {
34 | return timeout;
35 | }
36 | }
37 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/authentication/phone/PhoneCodeAuthenticationToken.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.authentication.phone;
2 |
3 | import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
4 | import org.springframework.security.core.GrantedAuthority;
5 | import org.springframework.security.core.SpringSecurityCoreVersion;
6 |
7 | import java.util.Collection;
8 |
9 | /**
10 | * @author zido
11 | */
12 | public class PhoneCodeAuthenticationToken extends UsernamePasswordAuthenticationToken {
13 | private static final long serialVersionUID = SpringSecurityCoreVersion.SERIAL_VERSION_UID;
14 |
15 | public PhoneCodeAuthenticationToken(String phone, String code) {
16 | super(phone, code);
17 | }
18 |
19 | public PhoneCodeAuthenticationToken(String phone, String code, Collection authorities) {
20 | super(phone, code, authorities);
21 | }
22 | }
23 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/authentication/phone/PhoneCodeCache.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.authentication.phone;
2 |
3 | /**
4 | * 缓存手机号验证码接口
5 | *
6 | * @author zido
7 | */
8 | public interface PhoneCodeCache {
9 | /**
10 | * 放入手机号所属验证码
11 | *
12 | * @param phone 手机号
13 | * @param code 验证码
14 | */
15 | void put(String phone, String code);
16 |
17 | /**
18 | * 获取手机号验证码
19 | *
20 | * @param phone 手机号
21 | * @return 验证码
22 | */
23 | String getCode(String phone);
24 | }
25 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/authentication/phone/PhoneCodeService.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.authentication.phone;
2 |
3 | /**
4 | * 手机号验证码发送接口
5 | *
6 | * @author zido
7 | */
8 | public interface PhoneCodeService {
9 | /**
10 | * 发送验证码
11 | *
12 | * @param phone 手机号
13 | * @param code 验证码
14 | */
15 | void sendCode(String phone, String code);
16 | }
17 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/authentication/phone/SpringRedisPhoneCodeCache.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.authentication.phone;
2 |
3 | import io.jsonwebtoken.lang.Assert;
4 | import org.springframework.beans.factory.InitializingBean;
5 | import org.springframework.data.redis.core.StringRedisTemplate;
6 |
7 | import java.util.concurrent.TimeUnit;
8 |
9 | /**
10 | * 使用spring redis template实现的手机号验证码缓存
11 | *
12 | * @author zido
13 | */
14 | public class SpringRedisPhoneCodeCache implements PhoneCodeCache, InitializingBean {
15 | private StringRedisTemplate template;
16 | private String keyPrefix;
17 | private long timeout;
18 | private TimeUnit unit;
19 |
20 | public SpringRedisPhoneCodeCache() {
21 | this.setKeyPrefix("coffee:phone:");
22 | this.setTimeout(60, TimeUnit.SECONDS);
23 | }
24 |
25 | @Override
26 | public void put(String phone, String code) {
27 | template.opsForValue().set(getKey(phone), code, timeout, unit);
28 | }
29 |
30 | @Override
31 | public String getCode(String phone) {
32 | return template.opsForValue().get(getKey(phone));
33 | }
34 |
35 | public void setTemplate(StringRedisTemplate template) {
36 | this.template = template;
37 | }
38 |
39 | protected String getKey(String phone) {
40 | return keyPrefix + phone;
41 | }
42 |
43 | public void setKeyPrefix(String keyPrefix) {
44 | this.keyPrefix = keyPrefix;
45 | }
46 |
47 | public void setTimeout(long timeout, TimeUnit unit) {
48 | this.timeout = timeout;
49 | this.unit = unit;
50 | }
51 |
52 | @Override
53 | public void afterPropertiesSet() {
54 | Assert.notNull(template, "redis template cannot be null");
55 | }
56 | }
57 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/configurers/RestAccessDeniedHandlerImpl.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.configurers;
2 |
3 | import org.springframework.http.MediaType;
4 | import org.springframework.security.access.AccessDeniedException;
5 | import org.springframework.security.web.access.AccessDeniedHandler;
6 | import org.springframework.util.StringUtils;
7 |
8 | import javax.servlet.ServletException;
9 | import javax.servlet.http.HttpServletRequest;
10 | import javax.servlet.http.HttpServletResponse;
11 | import java.io.IOException;
12 |
13 | public class RestAccessDeniedHandlerImpl implements AccessDeniedHandler {
14 | private MediaType mediaType;
15 | private String successBody;
16 |
17 | public RestAccessDeniedHandlerImpl() {
18 | }
19 |
20 | public RestAccessDeniedHandlerImpl(String successBody) {
21 | this(MediaType.APPLICATION_JSON, successBody);
22 | }
23 |
24 | public RestAccessDeniedHandlerImpl(MediaType mediaType, String successBody) {
25 | this.mediaType = mediaType;
26 | this.successBody = successBody;
27 | }
28 |
29 | public void setMediaType(MediaType mediaType) {
30 | this.mediaType = mediaType;
31 | }
32 |
33 | public void setSuccessBody(String successBody) {
34 | this.successBody = successBody;
35 | }
36 |
37 | @Override
38 | public void handle(HttpServletRequest request, HttpServletResponse response,
39 | AccessDeniedException accessDeniedException) throws IOException, ServletException {
40 | response.setStatus(HttpServletResponse.SC_FORBIDDEN);
41 | if (this.mediaType != null) {
42 | response.setHeader("Content-Type", this.mediaType.toString());
43 | }
44 | if (StringUtils.hasLength(successBody)) {
45 | response.getWriter().write(successBody);
46 | }
47 | }
48 | }
49 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/configurers/RestLogoutSuccessHandler.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.configurers;
2 |
3 | import org.springframework.security.core.Authentication;
4 | import org.springframework.security.web.authentication.logout.LogoutSuccessHandler;
5 | import site.zido.coffee.mvc.utils.ResponseUtils;
6 |
7 | import javax.servlet.ServletException;
8 | import javax.servlet.http.HttpServletRequest;
9 | import javax.servlet.http.HttpServletResponse;
10 | import java.io.IOException;
11 |
12 | /**
13 | * @author zido
14 | */
15 | public class RestLogoutSuccessHandler implements LogoutSuccessHandler {
16 | @Override
17 | public void onLogoutSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication)
18 | throws IOException, ServletException {
19 | ResponseUtils.json(response, 200);
20 | }
21 | }
22 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/configurers/RestSecurityConfigureAdapter.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.configurers;
2 |
3 | import org.springframework.security.config.annotation.web.builders.HttpSecurity;
4 | import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
5 | import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
6 | import org.springframework.security.web.context.request.async.WebAsyncManagerIntegrationFilter;
7 | import site.zido.coffee.security.authentication.RestAuthenticationFailureHandler;
8 | import site.zido.coffee.security.authentication.RestAuthenticationSuccessHandler;
9 | import site.zido.coffee.security.token.RestAuthenticationEntryPoint;
10 |
11 | /**
12 | * 包装WebSecurityConfigurerAdapter,加入关注restful api的默认配置
13 | */
14 | public class RestSecurityConfigureAdapter extends WebSecurityConfigurerAdapter {
15 | private boolean disableDefaults = false;
16 |
17 | public RestSecurityConfigureAdapter() {
18 | super(true);
19 | }
20 |
21 | protected void configure(HttpSecurity http) throws Exception {
22 | if (!disableDefaults) {
23 | http.csrf(AbstractHttpConfigurer::disable).addFilter(new WebAsyncManagerIntegrationFilter())
24 | .exceptionHandling(handling -> handling.accessDeniedHandler(new RestAccessDeniedHandlerImpl())
25 | .authenticationEntryPoint(new RestAuthenticationEntryPoint()))
26 | .headers().and().apply(new RestSecurityContextConfigurer<>()).and()
27 | .formLogin(form -> form.successHandler(new RestAuthenticationSuccessHandler())
28 | .failureHandler(new RestAuthenticationFailureHandler())
29 | .loginProcessingUrl("/users/sessions"))
30 | .anonymous().and().servletApi().and().logout();
31 | }
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/token/JwtRefreshProperties.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.token;
2 |
3 | public class JwtRefreshProperties {
4 | private long refreshTokenExpirationInMs;
5 | private String issue;
6 | private String refreshSecret;
7 |
8 | public long getRefreshTokenExpirationInMs() {
9 | return refreshTokenExpirationInMs;
10 | }
11 |
12 | public void setRefreshTokenExpirationInMs(long refreshTokenExpirationInMs) {
13 | this.refreshTokenExpirationInMs = refreshTokenExpirationInMs;
14 | }
15 |
16 | public String getIssue() {
17 | return issue;
18 | }
19 |
20 | public void setIssue(String issue) {
21 | this.issue = issue;
22 | }
23 |
24 | public String getRefreshSecret() {
25 | return refreshSecret;
26 | }
27 |
28 | public void setRefreshSecret(String refreshSecret) {
29 | this.refreshSecret = refreshSecret;
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/token/JwtTokenProperties.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.token;
2 |
3 | /**
4 | * jwt token相关属性
5 | */
6 | public class JwtTokenProperties {
7 | private long jwtExpirationInMs;
8 | private String issue;
9 | private String secret;
10 | private String authHeaderName;
11 | private JwtRefreshProperties refreshment;
12 |
13 | public long getJwtExpirationInMs() {
14 | return jwtExpirationInMs;
15 | }
16 |
17 | public void setJwtExpirationInMs(long jwtExpirationInMs) {
18 | this.jwtExpirationInMs = jwtExpirationInMs;
19 | }
20 |
21 | public String getIssue() {
22 | return issue;
23 | }
24 |
25 | public void setIssue(String issue) {
26 | this.issue = issue;
27 | }
28 |
29 | public String getSecret() {
30 | return secret;
31 | }
32 |
33 | public void setSecret(String secret) {
34 | this.secret = secret;
35 | }
36 |
37 | public String getAuthHeaderName() {
38 | return authHeaderName;
39 | }
40 |
41 | public void setAuthHeaderName(String authHeaderName) {
42 | this.authHeaderName = authHeaderName;
43 | }
44 |
45 | public JwtRefreshProperties getRefreshment() {
46 | return refreshment;
47 | }
48 |
49 | public void setRefreshment(JwtRefreshProperties refreshment) {
50 | this.refreshment = refreshment;
51 | }
52 |
53 | }
54 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/token/JwtWriterResponse.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.token;
2 |
3 | import io.jsonwebtoken.JwtBuilder;
4 | import io.jsonwebtoken.Jwts;
5 | import io.jsonwebtoken.SignatureAlgorithm;
6 | import org.springframework.security.authentication.AnonymousAuthenticationToken;
7 | import org.springframework.security.core.context.SecurityContext;
8 | import org.springframework.security.core.context.SecurityContextHolder;
9 | import org.springframework.security.web.util.OnCommittedResponseWrapper;
10 |
11 | import javax.servlet.http.HttpServletResponse;
12 | import java.util.Date;
13 |
14 | public class JwtWriterResponse extends OnCommittedResponseWrapper {
15 | private final long jwtExpirationInMs;
16 | private final String issue;
17 | private final String secret;
18 | private final String authHeaderName;
19 |
20 | public JwtWriterResponse(HttpServletResponse response, long jwtExpirationInMs, String issue, String secret, String authHeaderName) {
21 | super(response);
22 | this.jwtExpirationInMs = jwtExpirationInMs;
23 | this.issue = issue;
24 | this.secret = secret;
25 | this.authHeaderName = authHeaderName;
26 | }
27 |
28 | @Override
29 | protected void onResponseCommitted() {
30 | writeToken(SecurityContextHolder.getContext());
31 | this.disableOnResponseCommitted();
32 | }
33 |
34 | protected void writeToken(SecurityContext context) {
35 | if (isDisableOnResponseCommitted()) {
36 | return;
37 | }
38 | if (context.getAuthentication() != null) {
39 | String newToken = generateNewToken(context);
40 | addTokenToResponse(getHttpResponse(), newToken);
41 | doAfterWriteToken(context);
42 | }
43 | }
44 |
45 | protected void doAfterWriteToken(SecurityContext context) {
46 |
47 | }
48 |
49 | protected void addTokenToResponse(HttpServletResponse response, String token) {
50 | response.setHeader(authHeaderName, token);
51 | }
52 |
53 | protected String generateNewToken(SecurityContext subject) {
54 | Date now = new Date();
55 | Date expiryDate = new Date(now.getTime() + jwtExpirationInMs);
56 |
57 | JwtBuilder builder = Jwts.builder();
58 | //如果开启匿名，则写入匿名token配置
59 | if (subject instanceof AnonymousAuthenticationToken) {
60 | builder.claim("role", "anonymous");
61 | }
62 | //如果是匿名用户则subject为空字符串
63 | return builder
64 | .setSubject(subject.getAuthentication().getName())
65 | .setIssuedAt(now)
66 | .setIssuer(issue)
67 | .setExpiration(expiryDate)
68 | .signWith(SignatureAlgorithm.HS512, secret)
69 | .compact();
70 | }
71 |
72 | protected HttpServletResponse getHttpResponse() {
73 | return (HttpServletResponse) getResponse();
74 | }
75 | }
76 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/token/RefreshWriterResponse.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.token;
2 |
3 | import io.jsonwebtoken.Jwts;
4 | import io.jsonwebtoken.SignatureAlgorithm;
5 | import org.springframework.security.core.context.SecurityContext;
6 |
7 | import javax.servlet.http.HttpServletResponse;
8 | import java.util.Date;
9 |
10 | public class RefreshWriterResponse extends JwtWriterResponse {
11 | private long refreshTokenExpirationInMs;
12 | private String issue;
13 | private String refreshSecret;
14 | private String refreshHeaderName;
15 |
16 | public RefreshWriterResponse(HttpServletResponse response,
17 | long jwtExpirationInMs,
18 | String issue,
19 | String jwtSecret,
20 | String authHeaderName,
21 | long refreshTokenExpirationInMs,
22 | String refreshSecret) {
23 | super(response, jwtExpirationInMs, issue, jwtSecret, authHeaderName);
24 | this.refreshTokenExpirationInMs = refreshTokenExpirationInMs;
25 | this.refreshSecret = refreshSecret;
26 | }
27 |
28 | public RefreshWriterResponse(HttpServletResponse response,
29 | long jwtExpirationInMs,
30 | String issue,
31 | String jwtSecret,
32 | String authHeaderName,
33 | long refreshTokenExpirationInMs) {
34 | super(response, jwtExpirationInMs, issue, jwtSecret, authHeaderName);
35 | this.refreshTokenExpirationInMs = refreshTokenExpirationInMs;
36 | this.refreshSecret = jwtSecret;
37 | }
38 |
39 | protected String generateRefreshToken(SecurityContext subject) {
40 | Date now = new Date();
41 | Date expiryDate = new Date(now.getTime() + refreshTokenExpirationInMs);
42 |
43 | return Jwts.builder()
44 | .setSubject(subject.getAuthentication().getName())
45 | .setIssuedAt(now)
46 | .setIssuer(issue)
47 | .setExpiration(expiryDate)
48 | .claim("scope", "refresh")
49 | .signWith(SignatureAlgorithm.HS512, refreshSecret)
50 | .compact();
51 | }
52 |
53 | @Override
54 | protected void doAfterWriteToken(SecurityContext context) {
55 | getHttpResponse().setHeader(refreshHeaderName, generateRefreshToken(context));
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/token/RestAuthenticationEntryPoint.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.token;
2 |
3 | import org.springframework.http.MediaType;
4 | import org.springframework.security.core.AuthenticationException;
5 | import org.springframework.security.web.AuthenticationEntryPoint;
6 | import org.springframework.util.StringUtils;
7 |
8 | import javax.servlet.ServletException;
9 | import javax.servlet.http.HttpServletRequest;
10 | import javax.servlet.http.HttpServletResponse;
11 | import java.io.IOException;
12 |
13 | /**
14 | * @author zido
15 | */
16 | public class RestAuthenticationEntryPoint implements AuthenticationEntryPoint {
17 | private MediaType mediaType;
18 | private String content;
19 |
20 | public RestAuthenticationEntryPoint() {
21 | }
22 |
23 | public RestAuthenticationEntryPoint(String content) {
24 | this(MediaType.APPLICATION_JSON, content);
25 | }
26 |
27 | public RestAuthenticationEntryPoint(MediaType mediaType, String content) {
28 | this.mediaType = mediaType;
29 | this.content = content;
30 | }
31 |
32 | public void setMediaType(MediaType mediaType) {
33 | this.mediaType = mediaType;
34 | }
35 |
36 | public void setContent(String content) {
37 | this.content = content;
38 | }
39 |
40 | @Override
41 | public void commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException authException) throws IOException, ServletException {
42 | response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
43 | if (this.mediaType != null) {
44 | response.setHeader("Content-Type", this.mediaType.toString());
45 | }
46 | if (StringUtils.hasLength(content)) {
47 | response.getWriter().write(content);
48 | }
49 | }
50 | }
51 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/main/java/site/zido/coffee/security/token/TokenInvalidException.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.token;
2 |
3 | /**
4 | * token 失效异常
5 | *
6 | * @author zido
7 | */
8 | public class TokenInvalidException extends RuntimeException {
9 | public TokenInvalidException(String msg, Throwable t) {
10 | super(msg, t);
11 | }
12 |
13 | public TokenInvalidException(String msg) {
14 | super(msg);
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-rest-security/src/test/java/site/zido/coffee/security/authentication/phone/CustomCodeGeneratorTest.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.security.authentication.phone;
2 |
3 | import org.junit.jupiter.api.Assertions;
4 | import org.junit.jupiter.api.Test;
5 |
6 | public class CustomCodeGeneratorTest {
7 | @Test
8 | public void testGenerate() {
9 | CustomCodeGenerator generator = new CustomCodeGenerator(CustomCodeGenerator.Mode.NUMBER);
10 | String code = generator.generateCode("xxx");
11 | Assertions.assertEquals(6, code.length());
12 | String code2 = generator.generateCode("xxx");
13 | Assertions.assertNotEquals(code, code2);
14 | }
15 |
16 | @Test
17 | public void testMaxAndMinGenerate() {
18 | CustomCodeGenerator generator = new CustomCodeGenerator(CustomCodeGenerator.Mode.NUMBER);
19 | generator.setMaxLength(10);
20 | generator.setMinLength(1);
21 | String code = generator.generateCode("");
22 | Assertions.assertTrue(1 <= code.length() && code.length() <= 10);
23 | }
24 | }
25 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 |
6 | coffee-modules
7 | site.zido
8 | 0.3.0-SNAPSHOT
9 |
10 | 4.0.0
11 |
12 | coffee-webmvc
13 | Spring Web Mvc 增强
14 |
15 |
16 |
17 | site.zido
18 | coffee-core
19 |
20 |
21 | org.springframework
22 | spring-webmvc
23 |
24 |
25 | javax.validation
26 | validation-api
27 | true
28 |
29 |
30 | javax.servlet
31 | javax.servlet-api
32 |
33 |
34 | org.slf4j
35 | slf4j-api
36 |
37 |
38 | com.fasterxml.jackson.core
39 | jackson-databind
40 |
41 |
42 |
43 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/src/main/java/site/zido/coffee/mvc/CommonErrorCode.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.mvc;
2 |
3 | /**
4 | * 异常错误码
5 | *
6 | * @author zido
7 | */
8 | public class CommonErrorCode {
9 | /**
10 | * 未知异常错误码
11 | */
12 | public static final int UNKNOWN = 1;
13 | /**
14 | * 参数异常错误码
15 | */
16 | public static final int VALIDATION_FAILED = 2;
17 | /**
18 | * 被限制访问的异常错误码
19 | */
20 | public static final int LIMIT = 3;
21 | }
22 |
23 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/src/main/java/site/zido/coffee/mvc/exceptions/CommonBusinessException.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.mvc.exceptions;
2 |
3 | /**
4 | * 业务异常
5 | *
6 | * @author zido
7 | */
8 | public class CommonBusinessException extends RuntimeException {
9 | private static final long serialVersionUID = -8246671096687096493L;
10 | /**
11 | * 一般业务异常不建议使用500及以上http status
12 | */
13 | private int httpStatus;
14 | /**
15 | * 补充错误码，请注意，当允许全局返回{@link site.zido.coffee.mvc.rest.Result}时，
16 | * code默认为0，所以不建议占用code为0，请设置其他的code
17 | */
18 | private int code;
19 | private String msg;
20 |
21 | public CommonBusinessException(int httpStatus, int code, String msg) {
22 | super(buildMsg(httpStatus, code, msg));
23 | this.httpStatus = httpStatus;
24 | this.code = code;
25 | this.msg = msg;
26 | }
27 |
28 | public CommonBusinessException(int httpStatus, int code, Throwable t) {
29 | super(
30 | buildMsg(httpStatus,
31 | code,
32 | t instanceof CommonBusinessException
33 | ? ((CommonBusinessException) t).getMsg()
34 | : t.getMessage()),
35 | t);
36 | this.httpStatus = httpStatus;
37 | this.code = code;
38 | if (t instanceof CommonBusinessException) {
39 | this.msg = ((CommonBusinessException) t).getMsg();
40 | } else {
41 | this.msg = "未知异常";
42 | }
43 | }
44 |
45 | protected CommonBusinessException(Throwable t) {
46 | this(400, 1, t);
47 | }
48 |
49 | public CommonBusinessException(int httpStatus, String msg) {
50 | this(httpStatus, 1, msg);
51 | }
52 |
53 | public CommonBusinessException(int httpStatus) {
54 | this(httpStatus, 1, "未知异常");
55 | }
56 |
57 |
58 | public CommonBusinessException() {
59 | this(400);
60 | }
61 |
62 | private static String buildMsg(int httpStatus, int code, String msg) {
63 | return msg + "(http status:" + httpStatus + ",code:" + code + ")";
64 | }
65 |
66 | public int getCode() {
67 | return code;
68 | }
69 |
70 | protected void setCode(int code) {
71 | this.code = code;
72 | }
73 |
74 | public String getMsg() {
75 | return msg;
76 | }
77 |
78 | protected void setMsg(String msg) {
79 | this.msg = msg;
80 | }
81 |
82 | public int getHttpStatus() {
83 | return httpStatus;
84 | }
85 |
86 | public void setHttpStatus(int httpStatus) {
87 | this.httpStatus = httpStatus;
88 | }
89 | }
90 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/src/main/java/site/zido/coffee/mvc/exceptions/EnableGlobalException.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.mvc.exceptions;
2 |
3 | import org.springframework.context.annotation.Configuration;
4 | import org.springframework.context.annotation.Import;
5 |
6 | import java.lang.annotation.*;
7 |
8 |
9 | /**
10 | * 是否允许全局使用统一异常处理，会将异常使用{@link site.zido.coffee.mvc.rest.HttpResponseBodyFactory}进行处理
11 | *
12 | *
13 | * @author zido
14 | */
15 | @Retention(RetentionPolicy.RUNTIME)
16 | @Target({ElementType.TYPE})
17 | @Documented
18 | @Import(GlobalExceptionConfiguration.class)
19 | @Configuration
20 | public @interface EnableGlobalException {
21 | }
22 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/src/main/java/site/zido/coffee/mvc/exceptions/EnableJavaxException.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.mvc.exceptions;
2 |
3 | import org.springframework.context.annotation.Configuration;
4 | import org.springframework.context.annotation.Import;
5 | import site.zido.coffee.mvc.rest.JavaxValidationExceptionAdvice;
6 |
7 | import java.lang.annotation.*;
8 |
9 | @Retention(RetentionPolicy.RUNTIME)
10 | @Target({ElementType.TYPE})
11 | @Documented
12 | @Import({JavaxValidationExceptionAdvice.class})
13 | @Configuration
14 | public @interface EnableJavaxException {
15 | }
16 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/src/main/java/site/zido/coffee/mvc/exceptions/GlobalExceptionConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.mvc.exceptions;
2 |
3 | import org.springframework.context.annotation.Bean;
4 | import org.springframework.context.annotation.Configuration;
5 | import org.springframework.context.annotation.Import;
6 | import site.zido.coffee.mvc.rest.GlobalExceptionAdvice;
7 | import site.zido.coffee.mvc.rest.HttpResponseBodyConfiguration;
8 | import site.zido.coffee.mvc.rest.HttpResponseBodyFactory;
9 |
10 | @Configuration
11 | @Import(HttpResponseBodyConfiguration.class)
12 | public class GlobalExceptionConfiguration {
13 | @Bean
14 | public GlobalExceptionAdvice advice(HttpResponseBodyFactory factory) {
15 | return new GlobalExceptionAdvice(factory);
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/src/main/java/site/zido/coffee/mvc/logger/CoffeeRequestLoggingFilter.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.mvc.logger;
2 |
3 | import org.slf4j.Logger;
4 | import org.slf4j.LoggerFactory;
5 | import org.springframework.web.filter.AbstractRequestLoggingFilter;
6 |
7 | import javax.servlet.http.HttpServletRequest;
8 |
9 | public class CoffeeRequestLoggingFilter extends AbstractRequestLoggingFilter {
10 | final Logger logger = LoggerFactory.getLogger("RequestLog");
11 |
12 | @Override
13 | protected boolean shouldLog(HttpServletRequest request) {
14 | return logger.isInfoEnabled();
15 | }
16 |
17 | @Override
18 | protected void beforeRequest(HttpServletRequest httpServletRequest, String s) {
19 | logger.info(s);
20 | }
21 |
22 | @Override
23 | protected void afterRequest(HttpServletRequest httpServletRequest, String s) {
24 | logger.info(s);
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/src/main/java/site/zido/coffee/mvc/logger/EnableRequestLogger.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.mvc.logger;
2 |
3 | import org.springframework.context.annotation.Configuration;
4 | import org.springframework.context.annotation.Import;
5 |
6 | import java.lang.annotation.*;
7 |
8 | @Retention(RetentionPolicy.RUNTIME)
9 | @Target({ElementType.TYPE})
10 | @Documented
11 | @Import(MvcLogConfiguration.class)
12 | @Configuration
13 | public @interface EnableRequestLogger {
14 | }
15 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/src/main/java/site/zido/coffee/mvc/logger/MvcLogConfiguration.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.mvc.logger;
2 |
3 | import org.springframework.context.annotation.Bean;
4 | import org.springframework.context.annotation.Configuration;
5 | import org.springframework.web.filter.AbstractRequestLoggingFilter;
6 |
7 | /**
8 | * 请求日志配置
9 | */
10 | @Configuration
11 | public class MvcLogConfiguration {
12 | @Bean
13 | public AbstractRequestLoggingFilter filter() {
14 | AbstractRequestLoggingFilter filter = new CoffeeRequestLoggingFilter();
15 | filter.setIncludeClientInfo(true);
16 | filter.setIncludeQueryString(true);
17 | return filter;
18 | }
19 | }
20 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/src/main/java/site/zido/coffee/mvc/rest/DefaultHttpResponseBodyFactory.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.mvc.rest;
2 |
3 | import java.util.Collection;
4 | import java.util.HashMap;
5 | import java.util.Map;
6 |
7 | /**
8 | * 默认rest响应体实现类
9 | *
10 | * @author zido
11 | */
12 | public class DefaultHttpResponseBodyFactory implements HttpResponseBodyFactory {
13 | @Override
14 | public boolean isExceptedClass(Class clazz) {
15 | return Result.class.isAssignableFrom(clazz);
16 | }
17 |
18 | @Override
19 | public Object success(Object data) {
20 | return Result.success(data);
21 | }
22 |
23 | @Override
24 | public Object error(int code, String message, Collection errors) {
25 | return Result.error(code, message, errors);
26 | }
27 |
28 | @Override
29 | public Map errorToMap(int code, String message, Collection errors) {
30 | Map result = new HashMap<>(3);
31 | result.put("code", code);
32 | result.put("message", message);
33 | result.put("errors", errors);
34 | return result;
35 | }
36 | }
37 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/src/main/java/site/zido/coffee/mvc/rest/DefaultResult.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.mvc.rest;
2 |
3 | import java.util.Collection;
4 |
5 | public class DefaultResult implements Result {
6 | private static final long serialVersionUID = -3266931205943696705L;
7 | private int code = 0;
8 | private String message;
9 | private T result;
10 | private Collection errors;
11 |
12 | public int getCode() {
13 | return code;
14 | }
15 |
16 | public void setCode(int code) {
17 | this.code = code;
18 | }
19 |
20 | public String getMessage() {
21 | return message;
22 | }
23 |
24 | public void setMessage(String message) {
25 | this.message = message;
26 | }
27 |
28 | public T getResult() {
29 | return result;
30 | }
31 |
32 | public void setResult(T result) {
33 | this.result = result;
34 | }
35 |
36 | public Collection getErrors() {
37 | return errors;
38 | }
39 |
40 | public void setErrors(Collection errors) {
41 | this.errors = errors;
42 | }
43 | }
44 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/src/main/java/site/zido/coffee/mvc/rest/EnableGlobalResult.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.mvc.rest;
2 |
3 | import org.springframework.context.annotation.Configuration;
4 | import org.springframework.context.annotation.Import;
5 |
6 | import java.lang.annotation.*;
7 |
8 | /**
9 | * 是否允许全局使用统一返回值，enable为开关
10 | *
11 | * 如果全局使用统一返回值，则成功和失败结果均使用{@link Result}进行统一封装，
12 | * 否则仅当失败时使用统一的Result返回失败异常
13 | *
14 | * @author zido
15 | */
16 | @Retention(RetentionPolicy.RUNTIME)
17 | @Target({ElementType.TYPE})
18 | @Documented
19 | @Import(GlobalRestConfiguration.class)
20 | @Configuration
21 | public @interface EnableGlobalResult {
22 | }
23 |
--------------------------------------------------------------------------------
/coffee-modules/coffee-webmvc/src/main/java/site/zido/coffee/mvc/rest/GlobalExceptionAdvice.java:
--------------------------------------------------------------------------------
1 | package site.zido.coffee.mvc.rest;
2 |
3 |
4 | import org.springframework.core.annotation.Order;
5 | import org.springframework.http.ResponseEntity;
6 | import org.springframework.web.bind.annotation.ExceptionHandler;
7 | import org.springframework.web.bind.annotation.RestControllerAdvice;
8 | import org.springframework.web.context.request.WebRequest;
9 | import site.zido.coffee.mvc.exceptions.CommonBusinessException;
10 |
11 | import javax.servlet.http.HttpServletResponse;
12 | import javax.validation.ConstraintViolationException;
13 |
14 | /**
15 | * server 异常处理,兜底处理
16 | *
17 | * @author zido
18 | */
19 | @RestControllerAdvice
20 | @Order
21 | public class GlobalExceptionAdvice extends BaseGlobalExceptionHandler {
22 | public GlobalExceptionAdvice(HttpResponseBodyFactory factory) {
23 | super(factory);
24 | }
25 |
26 | @ExceptionHandler(CommonBusinessException.class)
27 | @Override
28 | protected ResponseEntity