SofaTracerSpanContext (tracer-core 2.1.4 API)

java.lang.Object
- com.alipay.common.tracer.core.context.span.SofaTracerSpanContext

所有已实现的接口:

io.opentracing.SpanContext
```
public class SofaTracerSpanContext
extends Object
implements io.opentracing.SpanContext
```
SofaTracerSpanContext

从以下版本开始:

2017/06/17

作者:

yangguanchao

字段概要

字段
限定符和类型字段和说明

static String RPC_ID_SEPARATOR

字段
限定符和类型	字段和说明
`static String`	`RPC_ID_SEPARATOR`

构造器概要

构造器
构造器和说明
`SofaTracerSpanContext()`
`SofaTracerSpanContext(String traceId, String spanId)`
`SofaTracerSpanContext(String traceId, String spanId, String parentId)`
`SofaTracerSpanContext(String traceId, String spanId, String parentId, boolean isSampled)`

方法概要

方法
限定符和类型	方法和说明
`SofaTracerSpanContext`	`addBizBaggage(Map<String,String> bizBaggage)`
`SofaTracerSpanContext`	`addSysBaggage(Map<String,String> sysBaggage)`
`Iterable<Map.Entry<String,String>>`	`baggageItems()` 系统和业务 baggage 均返回
`SofaTracerSpanContext`	`cloneInstance()` clone 一个当前模型
`void`	`deserializeBizBaggage(String bizBaggageAttrs)` 将一个穿透属性序列化后的 String，反序列化回来成为一个 Map 接口此方法一般是 Tracer 内部或者直接集成 Tracer 的中间件使用
`static SofaTracerSpanContext`	`deserializeFromString(String deserializedValue)` 反序列化并还原一个 SofaTracerSpanContext,与 `serializeSpanContext()` 互逆
`void`	`deserializeSysBaggage(String sysBaggageAttrs)`
`boolean`	`equals(Object o)`
`Map<String,String>`	`getBizBaggage()`
`String`	`getBizBaggageItem(String key)`
`String`	`getBizSerializedBaggage()` 将 Tracer 中的穿透属性序列化成一个 String 此方法一般是 Tracer 内部或者直接集成 Tracer 的中间件使用
`AtomicInteger`	`getChildContextIndex()`
`String`	`getParentId()`
`String`	`getSpanId()`
`Map<String,String>`	`getSysBaggage()`
`String`	`getSysBaggageItem(String key)`
`String`	`getSysSerializedBaggage()`
`String`	`getTraceId()`
`int`	`hashCode()`
`boolean`	`isSampled()`
`String`	`lastChildContextId()` 获取上一个子上下文的 rpcId
`String`	`nextChildContextId()` 获取下一个子上下文的 ID
`static SofaTracerSpanContext`	`rootStart()` 作为根节点而开始注意:1.留下这个接口,不对接具体的 tracer 实现,主要为了在序列化或者反序列化发生异常时,做补救 2.不可以随意调用此方法,正确的入口应该是 `SofaTracer.SofaTracerSpanBuilder#createRootSpanContext()`
`static SofaTracerSpanContext`	`rootStart(boolean isSampled)`
`String`	`serializeSpanContext()` 将 SpanContext 序列化为一个字符串,与 `deserializeFromString(java.lang.String)` 互逆
`SofaTracerSpanContext`	`setBizBaggageItem(String key, String value)`
`void`	`setSampled(boolean sampled)`
`void`	`setSpanId(String spanId)` 允许设置 spanId
`SofaTracerSpanContext`	`setSysBaggageItem(String key, String value)`
`void`	`setTraceId(String traceId)` 允许设置 tracdId
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料
- RPC_ID_SEPARATOR
```
public static final String RPC_ID_SEPARATOR
```
  另请参阅:
  常量字段值

构造器详细资料

SofaTracerSpanContext
```
public SofaTracerSpanContext()
```

SofaTracerSpanContext

public SofaTracerSpanContext(String traceId,
                     String spanId)

SofaTracerSpanContext

public SofaTracerSpanContext(String traceId,
                     String spanId,
                     String parentId)

SofaTracerSpanContext

public SofaTracerSpanContext(String traceId,
                     String spanId,
                     String parentId,
                     boolean isSampled)

方法详细资料
- cloneInstance
```
public SofaTracerSpanContext cloneInstance()
```
  clone 一个当前模型
  
  返回:
  clone 对象
- addBizBaggage
```
public SofaTracerSpanContext addBizBaggage(Map<String,String> bizBaggage)
```
- addSysBaggage
```
public SofaTracerSpanContext addSysBaggage(Map<String,String> sysBaggage)
```
- baggageItems
```
public Iterable<Map.Entry<String,String>> baggageItems()
```
  系统和业务 baggage 均返回
  
  指定者:
  
  baggageItems 在接口中 io.opentracing.SpanContext
  
  返回:
  迭代器
- getBizSerializedBaggage
```
public String getBizSerializedBaggage()
```
  将 Tracer 中的穿透属性序列化成一个 String
  此方法一般是 Tracer 内部或者直接集成 Tracer 的中间件使用
  
  返回:
  序列化以后的穿透属性
- getSysSerializedBaggage
```
public String getSysSerializedBaggage()
```
- deserializeBizBaggage
```
public void deserializeBizBaggage(String bizBaggageAttrs)
```
  将一个穿透属性序列化后的 String，反序列化回来成为一个 Map 接口
  此方法一般是 Tracer 内部或者直接集成 Tracer 的中间件使用
  
  参数:
  bizBaggageAttrs - 序列化后的穿透属性 String
- deserializeSysBaggage
```
public void deserializeSysBaggage(String sysBaggageAttrs)
```
- serializeSpanContext
```
public String serializeSpanContext()
```
  将 SpanContext 序列化为一个字符串,与 deserializeFromString(java.lang.String) 互逆
  
  返回:
  序列化后的字符串, 格式:tcid:0,spid:1
- deserializeFromString
```
public static SofaTracerSpanContext deserializeFromString(String deserializedValue)
```
  反序列化并还原一个 SofaTracerSpanContext,与 serializeSpanContext() 互逆
  
  参数:
  deserializedValue - 反序列化的字符串,格式:tcid:0,spid:1
  
  返回:
  SofaTracerSpanContext
- rootStart
```
public static SofaTracerSpanContext rootStart()
```
  作为根节点而开始注意:1.留下这个接口,不对接具体的 tracer 实现,主要为了在序列化或者反序列化发生异常时,做补救 2.不可以随意调用此方法,正确的入口应该是 SofaTracer.SofaTracerSpanBuilder#createRootSpanContext()
  
  返回:
  根节点
- rootStart
```
public static SofaTracerSpanContext rootStart(boolean isSampled)
```
- setTraceId
```
public void setTraceId(String traceId)
```
  允许设置 tracdId
  
  参数:
  traceId - traceId
- setSpanId
```
public void setSpanId(String spanId)
```
  允许设置 spanId
  
  参数:
  spanId - spanId
- setBizBaggageItem
```
public SofaTracerSpanContext setBizBaggageItem(String key,
                                      String value)
```
- getBizBaggageItem
```
public String getBizBaggageItem(String key)
```
- setSysBaggageItem
```
public SofaTracerSpanContext setSysBaggageItem(String key,
                                      String value)
```
- getSysBaggageItem
```
public String getSysBaggageItem(String key)
```
- getTraceId
```
public String getTraceId()
```
- getSpanId
```
public String getSpanId()
```
- getParentId
```
public String getParentId()
```
- getBizBaggage
```
public Map<String,String> getBizBaggage()
```
- getSysBaggage
```
public Map<String,String> getSysBaggage()
```
- isSampled
```
public boolean isSampled()
```
- setSampled
```
public void setSampled(boolean sampled)
```
- getChildContextIndex
```
public AtomicInteger getChildContextIndex()
```
- nextChildContextId
```
public String nextChildContextId()
```
  获取下一个子上下文的 ID
  
  返回:
  下一个 spanId
- lastChildContextId
```
public String lastChildContextId()
```
  获取上一个子上下文的 rpcId
  
  返回:
  上一个子上下文的 rpcId
- equals
```
public boolean equals(Object o)
```
  覆盖:
  
  equals 在类中 Object
- hashCode
```
public int hashCode()
```
  覆盖:
  
  hashCode 在类中 Object
- toString
```
public String toString()
```
  覆盖:
  
  toString 在类中 Object

类 SofaTracerSpanContext

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

RPC_ID_SEPARATOR

构造器详细资料

SofaTracerSpanContext

SofaTracerSpanContext

SofaTracerSpanContext

SofaTracerSpanContext

方法详细资料

cloneInstance

addBizBaggage

addSysBaggage

baggageItems

getBizSerializedBaggage

getSysSerializedBaggage

deserializeBizBaggage

deserializeSysBaggage

serializeSpanContext

deserializeFromString

rootStart

rootStart

setTraceId

setSpanId

setBizBaggageItem

getBizBaggageItem

setSysBaggageItem

getSysBaggageItem

getTraceId

getSpanId

getParentId

getBizBaggage

getSysBaggage

isSampled

setSampled

getChildContextIndex

nextChildContextId

lastChildContextId

equals

hashCode

toString