SOFABoot quick start documentation issue

[nobodyiam]

I walked through the SOFABoot quick start guides and have some suggestions.

1. It's not always easy to change the parent pom, so it's better to document an alternative way, e.g. import the sofaboot-dependencies in dependencyManagement

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>com.alipay.sofa</groupId>
        <artifactId>sofaboot-dependencies</artifactId>
        <version>${sofa.boot.version}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

2. XML configuration is not widely used now, we'd better update the quick start documents using annotation examples

3. The annotation should be more user friendly

Take the example below:

1. after the @SofaService is annotated, the @Component should not be necessary
2. The interfaceType is not mandatory, our sample could remove it
3. It's not good to let users specify binding type as string, it's better to provide some enums for bindings.

@SofaService(interfaceType = HelloSyncService.class, bindings = {@SofaServiceBinding(bindingType = "bolt")})
@Component
public class HelloSyncServiceImpl implements HelloSyncService {
  ...
}

4. Registry instructions should be added in the quick start doc

Currently there is no such instruction, so the user could not run the demo following the quick start doc from scratch.

[seeflood]

3. It's not good to let users specify binding type as string, it's better to provide some enums for bindings.

@SofaService(interfaceType = HelloSyncService.class, bindings = {@SofaServiceBinding(bindingType = "bolt")})
@Component
public class HelloSyncServiceImpl implements HelloSyncService {
  ...
}

---

We can make it a community task.

Update 11.19: This task will be assigned to @irvingos

[Kunple-w]

如果类上@SofaService标记后@Component不是必须的, 那么方法上@SofaService标记后@Bean应该也不是必须的吧？

[seeflood]

@Kunple-w 恩恩 我理解是想改成这样的。用户只需要写 @SofaService 这一个注解，省的写两个

[Kunple-w]

@seeflood 我的想法是类似于Spring的@Bean和@Component/@Service的定位，应该有2个注解; 比如@SofaBean和@SofaService,而SofaService取消掉ElementType.METHOD的支持，这样的话SofaService有兼容性问题。
这样合适吗？

[renliangyu857]

after the @SofaService is annotated, the @component should not be necessary
please assign to me, thanks

[seeflood]

@Kunple-w 不能向下兼容的话，就不合适了~因为有很多生产用户在用，不兼容的话用户体验比较差。
我没细看过相关代码，不确定该咋搞，但听起来这个需求可以参考spring的组合注解来实现？我记得spring有那种一个注解A能拿来当注解B/C/D用的机制

[seeflood]

after the @SofaService is annotated, the @component should not be necessary please assign to me, thanks

Cool ! Could u please describe your design on how to implement it?
It's better we have a design discussion before coding, which avoids rework.
(You can write in either english or chinese,we don't mind

[Kunple-w]

@seeflood 实现方式有多种，

1. 组合注解，正如你说的，如@SofaService上添加@Component注解，改动量小，缺点就是@SofaService就和spring绑定到一起了，如果sofa的方向就是这个方向，这个倒也合适；
2. 自定义后置处理器解析@SofaService，类似于现在的方式，但是额外需要处理被注解bean放到cxt的逻辑，比组合注解改动量大一些，特点是该注解就和spring关系不大，只是sofa中定义的注解，可以独立处理；
   我理解1和2是对注解的定位略有差异，方向是需要确定的。

[EvenLjj]

@Kunple-w 考虑的还是很全面的，这个目前非开源版也做了些尝试，是通过组合注解的方式来实现的。因为SOFABoot中主要也是会强依赖spring相关的组件，所以推荐方式一，简单可行。

[EvenLjj]

@Darian1996 你的方案应该就是倾向于 @Kunple-w 上面所讲到的方案二，扫描注解已经在com.alipay.sofa.runtime.spring.ServiceBeanFactoryPostProcessor 中做了，只需要将其注册到 Spring 容器中应该就是可以了。这个需求可能还要关注的一点，不影响原来的@SofaService的使用，保持兼容性可能会成为影响这个方案设计的一个重要因素。

[ridKnight]

直接给SofaService类加上@Component和@Indexed注解就行了啊，这两个是meta annotation，被注解的其他注解会自动携带这两个注解

[renliangyu857]

直接给SofaService类加上@Component和@Indexed注解就行了啊，这两个是meta annotation，被注解的其他注解会自动携带这两个注解

学习了，没必要搞扫描那些，太复杂了